ESC REST Northbound API Documentation

Table of Contents

Resources managed by ESC RESTBehavior of ESC REST operationsESC REST API HeadersPathBody Parameters

CallbacksMedia TypeInternal IDsBodyString Restrictions in BodyInternal IDs

REST API Security

REST AuthenticationREST Https Support

REST API List

Resources managed by ESC REST

TenantsNetworksSubnetsFlavorsImagesDeployments

Behavior of ESC REST operationsGET operations are synchronous the requestresponse parameters are described with an example of arequestresponse

POST DELETE and PUT operations are asynchronous The asynchronous design use the ldquoweb hooksrdquoapproach using two independent one-way invocations - one to start a long-running operation (Client toESC) and the other one to notify a requester that it is completed (ESC to client)

ESC REST API HeadersPathBody Parameters

CallbacksOne of the header parameters of the operation request will contain a callback field whose value is a URIwhere the client expects a callback If this field is not present no callback will be performed

When the operation has completed (either successfully or unsuccessfully) ESC will perform a POSTrequest to the callback URI with an entity body containing the final status resource for this operation

ESC Clients can match a completion report back to the original request by comparing the internaltransaction ID field value to the one returned in the initial status response

ESC Clients are expected to provide a REST implementation for all the callbacks

Media TypeAll POST DELETE and PUT operations that require request andor response body must provide a headerparameter for media type Note that ESC is currently tested to accept and return XML

Internal IDsIn some of the ESC REST API there is a path parameter called _internal_id where the asterisk isreplaced by the resource type ESC Clients must provide an internal id for its resource it wants to createThe internal ids are enforced so the ESC Clients are able to refer to them in future operations such as GETPUT or DELETE requests

It is recommended that the ESC Client generated internal ids within the scope of the ESC

NOTE Reusing (recycling) of internal ids is not recommended This practice can lead to confusion in troubleshooting

BodyIn some of the POST PUT and DELETE requests you are required to provide a JSONXML bodyDepending on the resource you will need to provide certain fields in the body to successfully execute arequest Check the body section for each API (bottom of page) to see what fields are supported

String Restrictions in BodyInternal IDsBodySome string parametersfields such as id name are restricted by the underlying cloud provider such asOpenstack The allowable range for these parameters is included in the Create section for each resource inthis notation String minimum-length maximum length for example for Tenant name String 1 64

Generally names are either 164 (for TenantUser) or 1255 (for NetworkSubnetFlavorImageVM)

Internal IDIds are restricted to 72 characters such as internal_id 172 and external_id 172

Internal id naming must conform the standards stated in RFC 3986 Uniform Resource Identifier (URI)

Generic Syntax See sections related to URI encoding sections 22 Reserved Characters and 23Unreserved Characters ESC will accept an internal id specified in the request URL form the unreservedcharacter set unreserved = ALPHA DIGIT - _rdquo

NOTE the tilde ldquo~rdquo is not supported in the internal id character set

The internal id received in a request must be unique within the scope of all the domain resources (tenantnetwork subnet service catalog deployment ) For example you cannot create 2 networks with the sameinternal_network_id even if the networks are created under different tenants

REST API Security

REST AuthenticationOverviewESC REST API uses http basic access authentication where the ESC client will have to provide a usernameand password when making ESC REST requests The user name and password will be encoded withBase64 in transit but not encrypted or hashed HTTPS will be used in conjunction with Basic Authenticationto provide the encryption

SetupBy default the REST authentication is disabled To enable it the pass the argument --enable-auth to ESCbootvmpy ESC installation script

Username and PasswordThe REST interface has only one default usernamepassword (admincisco123)

The REST password can be updated using escadm tool from the ESC VM CLI

$ escadm rest set --username admin --password test123

The REST password can be reset using escadm tool from the ESC VM CLI

$ escadm rest set

You can also update the password through the REST API

http[ESCVM_IP]8080ESCManagerv0authenticationsetpassworduserName=yourUsernameamppassword=yourPassword

Sending an Authorized RequestTo send an authorized request an ESC client should send the request with the following header

Authorization Basic YWRtaW46Y2lzY28xMjM=

Generic Syntax See sections related to URI encoding sections 22 Reserved Characters and 23Unreserved Characters ESC will accept an internal id specified in the request URL form the unreservedcharacter set unreserved = ALPHA DIGIT - _rdquo

NOTE the tilde ldquo~rdquo is not supported in the internal id character set

The internal id received in a request must be unique within the scope of all the domain resources (tenantnetwork subnet service catalog deployment ) For example you cannot create 2 networks with the sameinternal_network_id even if the networks are created under different tenants

REST API Security

REST AuthenticationOverviewESC REST API uses http basic access authentication where the ESC client will have to provide a usernameand password when making ESC REST requests The user name and password will be encoded withBase64 in transit but not encrypted or hashed HTTPS will be used in conjunction with Basic Authenticationto provide the encryption

SetupBy default the REST authentication is disabled To enable it the pass the argument --enable-auth to ESCbootvmpy ESC installation script

Username and PasswordThe REST interface has only one default usernamepassword (admincisco123)

The REST password can be updated using escadm tool from the ESC VM CLI

$ escadm rest set --username admin --password test123

The REST password can be reset using escadm tool from the ESC VM CLI

$ escadm rest set

You can also update the password through the REST API

http[ESCVM_IP]8080ESCManagerv0authenticationsetpassworduserName=yourUsernameamppassword=yourPassword

Sending an Authorized RequestTo send an authorized request an ESC client should send the request with the following header

Authorization Basic YWRtaW46Y2lzY28xMjM=

01-Tenants Manage ESC tenantsGET v0tenants Get all tenants

Model Model Schema

where YWRtaW46Y2lzY28xMjM= is the Base64 enconded string of the default usernamepassword(admincisco123)

Most libraries and web clients have an interface for simply providing the usernamepassword and the appwill encode the usernamepassword and add the HTTP Basic Auth header

Example using the default admincisco123 credentials

http[ESCVM_IP]8080ESCManagerv0tenants

HeadersContent-Type applicationxml Authorization Basic YWRtaW46Y2lzY28xMjM=

REST Https SupportOverviewESC supports https communication over port 8443 ESC will generate a self-signed certificate that the clientwill need to trust to get the https communication going

SetupBy default the REST https is disabled and restricted to localhost To enable it pass the argument --enable-https-rest to ESC bootvmpy ESC installation script

HA ConsiderationsIn an HA setup every ESC HA VM will have its own self-signed generated certificate Upon an HAswitchover ESC north bound client will be required to re-accept the new certificate it will be served

REST API List

Implementation NotesAll tenants in ESC will be returned as a List

Response Class (Status 200)

[ internal_tenant_id string

Try it out

DELETE v0tenantsinternal_tenant_id Delete a tenant from ESC

Try it out

GET v0tenantsinternal_tenant_id Get a tenant by its name

external_tenant_id string name string enabled false event_type CREATE_TENANT managed_resource false ]

Response Content Type applicationxml

Implementation NotesDelete a tenant from ESC

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

internal_tenant_id (required) Internal tenant ID(max length 72characters)

path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Tenant deletion requestaccepted

400 Invalid Request

404 Invalid Tenant Id

Implementation NotesOnly tenants created using ESC will be checked

Try it out

POST v0tenantsinternal_tenant_id Create a tenant in ESC

Parameters

Parameter Value Description ParameterType Data Type

internal_tenant_id (required) Internal tenant ID(max length 72characters)

path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Get request accepted

404 Invalid Request - InvalidTenant ID

Implementation NotesCreates a tenant which will be managed by ESC and can be used for creating other resources under itExamplerequest

POST v0tenantstentest HTTP11Content-Type applicationxmlAccept applicationxmlCallback http1270019010Bodylttenant xmlns=urnietfparamsxmlnsnetconfbase10gt ltnamegtexample-tenantltnamegt ltmanaged_resourcegttrueltmanaged_resourcegtlttenantgt

After the tenant creation operation is done ECS will send a callback to the client with the result Examplecallback

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message Tenant successfully createdlttenant xmlns=urnietfparamsxmlnsnetconfbase10gt ltenabledgttrueltenabledgt

Model Model Schema

Try it out

02-Networks Manage ESC networks

ltevent_typegtCREATE_TENANTltevent_typegt ltexternal_tenant_idgt484c620285ea4f588227ff3396215980ltexternal_tenant_idgt ltinternal_tenant_idgttentestltinternal_tenant_idgt ltnamegtexample-tenantltnamegt ltmanaged_resourcegttrueltmanaged_resourcegtlttenantgt

Parameters

Parameter Value Description ParameterType Data Type

body (required)

Parameter contenttype

applicationxml

Tenantconfigurationpayload

body

internal_tenant_id string external_tenant_id string name string enabled false event_type CREATE_TENANT managed_resource false

Click to set as parameter value

Callback (required) Callback URLfor ESCnotifications

header string

internal_tenant_id (required) Internaltenant ID(max length72characters)

path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Tenant creation requestaccepted

400 Invalid Request

409 Conflicting Request

GET v0internalTenantIdnetworks Get all networks under a tenant

Try it out

DELETE v0internalTenantIdnetworksinternalNetworkIdDelete a network from an existing tenant in ESC

Implementation NotesAll networks under that tenant in ESC will be returned as a List

Parameters

Parameter Value Description ParameterType Data Type

internalTenantId (required) Internal tenant ID ofthe network (maxlength 72characters)

path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

Implementation NotesDelete a network from ESC

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

internalNetworkId (required) Internal network ID(max length 72characters)

path string

internalTenantId (required) Internal tenant ID ofthe network (maxlength 72characters)

path string

Response Messages

Try it out

GET v0internalTenantIdnetworksinternalNetworkIdGet a network by its tenant and internal network ID

Try it out

POST v0internalTenantIdnetworksinternalNetworkIdCreate a network under an existing tenant in ESC

HTTP StatusCode

Reason Response Model Headers

200 Request accepted

400 Invalid request

500 Internal server error

Implementation NotesOnly networks created using ESC will be checked

Parameters

Parameter Value Description ParameterType Data Type

internalTenantId (required) Internal tenant ID ofthe network (maxlength 72characters)

path string

internalNetworkId (required) Internal network ID(max length 72characters)

path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

404 Network Id not found

Implementation NotesCreate a network in ESC

Model Model Schema

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URLfor ESCnotifications

header string

internalTenantId (required) Internaltenant ID ofthe network(max length72characters)

path string

internalNetworkId (required) Internalnetwork ID(max length72characters)

path string

body (required)

Parameter contenttype

applicationxml

Networkconfigurationpayload

body

internalDeploymentId string internal_tenant_id string internal_network_id string name string shared false external_tenant_id string external_network_id string subnet [ string ] admin_state_up false locators datacenter string switch_name string event_type CREATE_NETWORK number_of_ports 0 provider_segmentation_id string router_external false provider_physical_network string provider_network_type string vlan_id 0 switch_name string

Click to set as parameter value

Try it out

03-Subnets Manage ESC subnetsGET v0internalTenantIdsubnets Get all subnets under a network

Try it out

DELETE v0internalTenantIdsubnetsinternalSubnetId Delete a subnet from an existing tenant in ESC

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid request

404 Network Id not found

409 Conflicting request

503 Unable to query VIM

Implementation NotesAll subnet under that network in ESC will be returned as a List

Parameters

Parameter Value Description ParameterType Data Type

internalNetworkId Internal network ID ofthe subnet (maxlength 72 characters)

header string

internalTenantId (required) Internal tenant ID ofthe subnet (maxlength 72characters)

path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

404 Not found

Try it out

GET v0internalTenantIdsubnetsinternalSubnetId Get a subnet by its tenant and internal subnet ID

Implementation NotesDelete a subnet from ESC

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

internalTenantId (required) Internal tenant ID ofthe subnet (maxlength 72 characters)

path string

internalSubnetId (required) Internal subnet ID(max length 72characters)

path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 Not found

500 Internal server error

Implementation NotesOnly subnets created using ESC will be checked

Parameters

Parameter Value Description ParameterType Data Type

internalTenantId (required) Internal tenant ID ofthe subnet (maxlength 72characters)

path string

internalSubnetId Internal subnet ID path string

Try it out

POST v0internalTenantIdsubnetsinternalSubnetId Create a subnet under an existing tenant in ESC

Model Model Schema

(required) (max length 72characters)

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

404 Not found

Implementation NotesCreate a subnet in ESC

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URLfor ESCnotifications

header string

internalTenantId (required) Internaltenant ID ofthe subnet(max length72characters)

path string

internalSubnetId (required) Internalsubnet ID(max length72characters)

path string

body (required)

Parameter contenttype

Subnetconfigurationpayload

body

internal_tenant_id string external_tenant_id string internal_network_id string external_network_id string internal_subnet_id string external_subnet_id string

Try it out

04-Images Manage ESC imagesGET v0images Get all images

Try it out

DELETE v0imagesinternalImageId Delete an image from ESC

applicationxml name string allocation_pools [ start string end string ] gateway_ip string ip_version 0 cidr string enable_dhcp false event_type CREATE_SUBNET

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 Not found

409 Conflicting Request

500 Internal server error

Implementation NotesAll images created in ESC will be returned as a List

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

Try it out

GET v0imagesinternalImageId Get the image by the internal image ID

Try it out

Implementation NotesDelete an image from ESC

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

internalImageId (required) Internal image ID(max length 72characters)

path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

500 Internal server error

Implementation NotesImages not created by ESC will not be checked

Parameters

Parameter Value Description ParameterType Data Type

internalImageId (required) Internal image ID(max length 72characters)

path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 Image Id not found

Try it out

POST v0imagesinternalImageId Create an image in ESC

Implementation NotesCreates an Image(Template) which will be managed by ESC and can be used for creating instance VMs

Example request

POST v0imagesmy_image_id HTTP11Content-Type applicationxmlAccept applicationxmlCallback http1270019010Body

ltxml version=10gtltimage xmlns=urnietfparamsxmlnsnetconfbase10gt ltnamegtuLinuxImgltnamegt ltsrcgthttpVAR_FILE_SERVER_IPshareimagesmyULinuxqcow2ltsrcgt ltdisk_busgtvirtioltdisk_busgtltimagegt

After the Image creation operation is done ESC will send a callback to the client with the result

Example callback

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message Image successfully created

ltxml version=10 encoding=UTF-8 standalone=yesgtltimage xmlns=urnietfparamsxmlnsnetconfbase10gt ltdisk_busgtvirtioltdisk_busgt lte1000_netgtfalselte1000_netgt ltevent_typegtCREATE_IMAGEltevent_typegt ltexternal_image_idgt5021843b-fcc5-2c1b-8fc4-935147f95872ltexternal_image_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltimageisenabledgttrueltimageisenabledgt ltnamegtuLinuxImgltnamegt ltinternal_image_idgtmy_image_idltinternal_image_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltvisibilitygtpublicltvisibilitygt

Try it out

05-Flavors Manage ESC flavorsGET v0flavors Get all flavors

ltsrcgthttpVAR_FILE_SERVER_IPshareimagesmyULinuxqcow2ltsrcgtltimagegt

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

internalImageId (required) Internal image ID(max length 72characters)

path string

body (required)

Parameter content type

applicationxml

ESC datamodel withthe image to create

body string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

409 Conflicting Request

500 Internal server error

Implementation NotesAll flavors created in ESC will be returned as a List

Response MessagesHTTP StatusCode Reason Response Model Headers

Try it out

DELETE v0flavorsinternalFlavorId Delete a flavor from ESC

Try it out

GET v0flavorsinternalFlavorId Get the flavor by the internal flavor ID

200 Request accepted

Implementation NotesDelete a flavor from ESC

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

internalFlavorId (required) Internal flavor ID(max length 72characters)

path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

404 Flavor Id not found

500 Internal server error

Implementation NotesFlavors not created by ESC will not be checked

Parameters

Parameter Value Description ParameterType Data Type

internalFlavorId (required) Internal flavor ID(max length 72characters)

path string

Try it out

POST v0flavorsinternalFlavorId Create a flavor in ESC

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

404 Flavor Id not found

406 Operation not supported onVIMFlavor part of serviceregistration

Implementation NotesCreates a Flavor which could be used for creating instance VMs

Example request

POST v0flavorsmy_flavor_id HTTP11Content-Type applicationxmlAccept applicationxmlCallback http1270019010Bodyltxml version=10gtltflavor xmlns=urnietfparamsxmlnsnetconfbase10gt ltnamegtlightVMFlavorltnamegt ltvcpusgt2ltvcpusgt ltmemory_mbgt2048ltmemory_mbgtltflavorgt

After the Flavor creation operation is done ESC will send a callback to the client with the result

Example callback

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message Flavor creation completed successfully createdltxml version=10 encoding=UTF-8 standalone=yesgtltflavor xmlns=urnietfparamsxmlnsnetconfbase10gt ltephemeral_disk_mbgt0ltephemeral_disk_mbgt ltevent_typegtCREATE_FLAVORltevent_typegt

Try it out

06-Deployments Manage ESC deployments

ltexternal_flavor_idgtfb63c114-de1a-40d8-abae-fa6011abd150ltexternal_flavor_idgt ltnamegtlightVMFlavorltnamegt ltinternal_flavor_idgtmy_flavor_idltinternal_flavor_idgt ltmemory_mbgt2048ltmemory_mbgt ltvcpusgt2ltvcpusgtltflavorgt

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

internalFlavorId (required) Internal flavor ID(max length 72characters)

path string

body (required)

Parameter content type

applicationxml

ESC datamodel withthe flavor to create

body string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 Flavor Id not found

406 Operation not supported onVIMFlavor part of serviceregistration

409 Conflicting Request

500 Internal server error

GET v0deployments Find all deployments

Try it out

DELETE v0deploymentsinternal_deployment_id Delete a deployment from ESC

Try it out

GET v0deploymentsinternal_deployment_id Find a deployment by its internal ID

Implementation NotesAll deployments created in ESC will be returned as a List

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

Implementation NotesDelete a deployment from ESC

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

internal_deployment_id (required) Internal ID of thedeployment (maxlength 72characters)

path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 Deployment Id not found

Implementation Notes

Try it out

POST v0deploymentsinternal_deployment_id Creates a deployment

A deployment will be returned if found in ESC

Parameters

Parameter Value Description ParameterType Data Type

internal_deployment_id (required) Internal ID of thedeployment (maxlength 1024characters)

path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

404 Deployment Id not found

Implementation NotesCreates a Simple deployment of Instance VMs

NOTE As deployment requirements vary a lot please see ESC User guide for datamodel excerpts of specificfunctionality you may desire thats not displayed in the simple example below

Example request

POST v0deploymentsmy_dep_id HTTP11Content-Type applicationxmlAccept applicationxmlCallback http1270019010Callback-ESC-Events http1270019010

Body

ltesc_datamodel xmlns=httpwwwciscocomescesc xmlnsns2=urnietfparamsxmlnsnetconfnotification10 lttenantsgt lttenantgt ltnamegtadminltnamegt ltdeploymentsgt ltdeploymentgt ltnamegtMyDemoDepNameltnamegt ltvm_groupgt

ltnamegtASA-1ltnamegt ltbootup_timegt300ltbootup_timegt ltreboot_timegt100ltreboot_timegt ltrecovery_wait_timegt10ltrecovery_wait_timegt ltimagegtASAltimagegt ltinterfacesgt ltinterfacegt ltnicidgt1ltnicidgt ltnetworkgtMgtNetworkltnetworkgt ltip_addressgt180016ltip_addressgt ltinterfacegt ltinterfacesgt ltscalinggt ltmin_activegt1ltmin_activegt ltmax_activegt1ltmax_activegt ltelasticgttrueltelasticgt ltstatic_ip_address_poolgt ltnetworkgtMgtNetworkltnetworkgt ltip_addressgt180016ltip_addressgt ltstatic_ip_address_poolgt ltscalinggt ltkpi_datagt ltkpigt ltevent_namegtVM_ALIVEltevent_namegt ltmetric_valuegt1ltmetric_valuegt ltmetric_condgtGTltmetric_condgt ltmetric_typegtUINT32ltmetric_typegt ltmetric_collectorgt lttypegtICMPPinglttypegt ltnicidgt1ltnicidgt ltpoll_frequencygt3ltpoll_frequencygt ltpolling_unitgtsecondsltpolling_unitgt ltcontinuous_alarmgtfalseltcontinuous_alarmgt ltmetric_collectorgtltkpigt ltkpi_datagt ltrulesgt ltadmin_rulesgt ltrulegt ltevent_namegtVM_ALIVEltevent_namegt ltactiongtALWAYS logltactiongt ltactiongtTRUE esc_vm_alive_notificationltactiongt ltrulegt ltadmin_rulesgt ltrulesgt ltconfig_datagt ltconfigurationgt ltdstgtday0-configltdstgt ltfilegthttpMY_FILE_SERVER_IPshareimagesday0-configASAvltfilegt

ltconfigurationgt ltconfigurationgt ltdstgtidtokenltdstgt ltfilegthttpMY_FILE_SERVER_IPshareimagesasa-smartconfigltfilegt ltconfigurationgt ltconfig_datagt ltplacementgt lttypegtzone_hostlttypegt ltzonegtMY_CLUSTER1ltzonegt ltplacementgt ltvolumesgt ltvolumegt ltnamegtMY_DATASTORE1ltnamegt ltvolidgt1ltvolidgt ltvolumegt ltvolumesgt ltvm_groupgt ltdeploymentgt ltdeploymentsgt lttenantgt lttenantsgtltesc_datamodelgt

While the Deployment operation is being processed successfully ESC will send a VM_DEPLOYED callback foreach VM created on the VIM as part of this deployment

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message VM Deployed

ltxml version=10 encoding=UTF-8 standalone=yesgtltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergt ltdefaultgtfalseltdefaultgt ltdatacentergt ltdeployment_detailsgt lthost_uuidgthost-14882lthost_uuidgt lthost_namegt108510313lthost_namegt ltvm_uuidgt50217d2d-8afb-41c2-cffd-d76b1239f51dltvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgtMgtNetworkltnetwork_uuidgt ltip_addressgt180016ltip_addressgt ltmac_addressgt005056a16a12ltmac_addressgt ltnic_idgt1ltnic_idgt

ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtASA-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_ASA-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_INERT_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_DEPLOYEDltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_DEPLOYING_STATEltservice_state_machine_stategtltdeploymentgt

While the Deployment operation is being processed successfully ESC will send a VM_ALIVE callback for eachmonitorablepingable VM created on the VIM as part of this deployment

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message VM_Alive event received VM ID [Sanity-vmware-de_ASA-1_0_b323effd-7f70-4055-b11e-0ef66f0a758d]

ltxml version=10 encoding=UTF-8 standalone=yesgtltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergt ltdefaultgtfalseltdefaultgt ltdatacentergt ltdeployment_detailsgt lthost_uuidgthost-14882lthost_uuidgt lthost_namegt108510313lthost_namegt ltvm_uuidgt50217d2d-8afb-41c2-cffd-d76b1239f51dltvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgtMgtNetworkltnetwork_uuidgt ltip_addressgt180016ltip_addressgt ltmac_addressgt005056a16a12ltmac_addressgt ltnic_idgt1ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt

ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtASA-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_ASA-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_ALIVE_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_ALIVEltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_INERT_STATEltservice_state_machine_stategtltdeploymentgt

After the Deployment operation is done ESC will send a SERVICE_ALIVE callback to the client with the result

Example callback

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message Service group deployment completed successfully

ltxml version=10 encoding=UTF-8 standalone=yesgtltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergt ltdefaultgtfalseltdefaultgt ltdatacentergt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtSERVICE_ALIVEltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_ACTIVE_STATEltservice_state_machine_stategtltdeploymentgt

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

Try it out

PUT v0deploymentsinternal_deployment_id Update an existing deployment in ESC

Callback-ESC-Events (required) Callback URL forESC eventnotifications

header string

internal_deployment_id (required) Internal ID of thedeployment (maxlength 72characters)

path string

body (required)

Parameter content type

applicationxml

ESC datamodel todeploy

body string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

503 Failed to query VIM

Implementation NotesUpdates an existing deployment Updates could be addition or removal of VM groups interfaces networks KPIsand Rules Day 0 config

After the service update operation is done ESC will send a callback to the client with the result

Example request of adding VM group

ltconfigurationgt ltconfigurationgt ltdstgtidtokenltdstgt ltfilegthttpMY_FILE_SERVER_IPshareimagesasa-smartconfigltfilegt ltconfigurationgt ltconfig_datagt ltplacementgt lttypegtzone_hostlttypegt ltzonegtMY_CLUSTER1ltzonegt ltplacementgt ltvolumesgt ltvolumegt ltnamegtMY_DATASTORE1ltnamegt ltvolidgt1ltvolidgt ltvolumegt ltvolumesgt ltvm_groupgt ltdeploymentgt ltdeploymentsgt lttenantgt lttenantsgtltesc_datamodelgt

While the Deployment operation is being processed successfully ESC will send a VM_DEPLOYED callback foreach VM created on the VIM as part of this deployment

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message VM Deployed

ltxml version=10 encoding=UTF-8 standalone=yesgtltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergt ltdefaultgtfalseltdefaultgt ltdatacentergt ltdeployment_detailsgt lthost_uuidgthost-14882lthost_uuidgt lthost_namegt108510313lthost_namegt ltvm_uuidgt50217d2d-8afb-41c2-cffd-d76b1239f51dltvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgtMgtNetworkltnetwork_uuidgt ltip_addressgt180016ltip_addressgt ltmac_addressgt005056a16a12ltmac_addressgt ltnic_idgt1ltnic_idgt

ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtASA-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_ASA-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_INERT_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_DEPLOYEDltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_DEPLOYING_STATEltservice_state_machine_stategtltdeploymentgt

While the Deployment operation is being processed successfully ESC will send a VM_ALIVE callback for eachmonitorablepingable VM created on the VIM as part of this deployment

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message VM_Alive event received VM ID [Sanity-vmware-de_ASA-1_0_b323effd-7f70-4055-b11e-0ef66f0a758d]

ltxml version=10 encoding=UTF-8 standalone=yesgtltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergt ltdefaultgtfalseltdefaultgt ltdatacentergt ltdeployment_detailsgt lthost_uuidgthost-14882lthost_uuidgt lthost_namegt108510313lthost_namegt ltvm_uuidgt50217d2d-8afb-41c2-cffd-d76b1239f51dltvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgtMgtNetworkltnetwork_uuidgt ltip_addressgt180016ltip_addressgt ltmac_addressgt005056a16a12ltmac_addressgt ltnic_idgt1ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt

ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtASA-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_ASA-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_ALIVE_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_ALIVEltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_INERT_STATEltservice_state_machine_stategtltdeploymentgt

After the Deployment operation is done ESC will send a SERVICE_ALIVE callback to the client with the result

Example callback

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message Service group deployment completed successfully

ltxml version=10 encoding=UTF-8 standalone=yesgtltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergt ltdefaultgtfalseltdefaultgt ltdatacentergt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtSERVICE_ALIVEltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_ACTIVE_STATEltservice_state_machine_stategtltdeploymentgt

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

Try it out

PUT v0deploymentsinternal_deployment_id Update an existing deployment in ESC

Callback-ESC-Events (required) Callback URL forESC eventnotifications

header string

internal_deployment_id (required) Internal ID of thedeployment (maxlength 72characters)

path string

body (required)

Parameter content type

applicationxml

ESC datamodel todeploy

body string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

503 Failed to query VIM

Implementation NotesUpdates an existing deployment Updates could be addition or removal of VM groups interfaces networks KPIsand Rules Day 0 config

After the service update operation is done ESC will send a callback to the client with the result

Example request of adding VM group

ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtASA-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_ASA-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_INERT_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_DEPLOYEDltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_DEPLOYING_STATEltservice_state_machine_stategtltdeploymentgt

While the Deployment operation is being processed successfully ESC will send a VM_ALIVE callback for eachmonitorablepingable VM created on the VIM as part of this deployment

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message VM_Alive event received VM ID [Sanity-vmware-de_ASA-1_0_b323effd-7f70-4055-b11e-0ef66f0a758d]

ltxml version=10 encoding=UTF-8 standalone=yesgtltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergt ltdefaultgtfalseltdefaultgt ltdatacentergt ltdeployment_detailsgt lthost_uuidgthost-14882lthost_uuidgt lthost_namegt108510313lthost_namegt ltvm_uuidgt50217d2d-8afb-41c2-cffd-d76b1239f51dltvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgtMgtNetworkltnetwork_uuidgt ltip_addressgt180016ltip_addressgt ltmac_addressgt005056a16a12ltmac_addressgt ltnic_idgt1ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt

ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtASA-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_ASA-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_ALIVE_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_ALIVEltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_INERT_STATEltservice_state_machine_stategtltdeploymentgt

After the Deployment operation is done ESC will send a SERVICE_ALIVE callback to the client with the result

Example callback

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message Service group deployment completed successfully

ltxml version=10 encoding=UTF-8 standalone=yesgtltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergt ltdefaultgtfalseltdefaultgt ltdatacentergt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtSERVICE_ALIVEltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_ACTIVE_STATEltservice_state_machine_stategtltdeploymentgt

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

Try it out

PUT v0deploymentsinternal_deployment_id Update an existing deployment in ESC

Callback-ESC-Events (required) Callback URL forESC eventnotifications

header string

internal_deployment_id (required) Internal ID of thedeployment (maxlength 72characters)

path string

body (required)

Parameter content type

applicationxml

ESC datamodel todeploy

body string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

503 Failed to query VIM

Implementation NotesUpdates an existing deployment Updates could be addition or removal of VM groups interfaces networks KPIsand Rules Day 0 config

After the service update operation is done ESC will send a callback to the client with the result

Example request of adding VM group

ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtASA-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_ASA-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_ALIVE_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_ALIVEltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_INERT_STATEltservice_state_machine_stategtltdeploymentgt

After the Deployment operation is done ESC will send a SERVICE_ALIVE callback to the client with the result

Example callback

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message Service group deployment completed successfully

ltxml version=10 encoding=UTF-8 standalone=yesgtltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergt ltdefaultgtfalseltdefaultgt ltdatacentergt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtSERVICE_ALIVEltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_ACTIVE_STATEltservice_state_machine_stategtltdeploymentgt

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

Try it out

PUT v0deploymentsinternal_deployment_id Update an existing deployment in ESC

Callback-ESC-Events (required) Callback URL forESC eventnotifications

header string

internal_deployment_id (required) Internal ID of thedeployment (maxlength 72characters)

path string

body (required)

Parameter content type

applicationxml

ESC datamodel todeploy

body string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

503 Failed to query VIM

Implementation NotesUpdates an existing deployment Updates could be addition or removal of VM groups interfaces networks KPIsand Rules Day 0 config

After the service update operation is done ESC will send a callback to the client with the result

Example request of adding VM group

Try it out

PUT v0deploymentsinternal_deployment_id Update an existing deployment in ESC

Callback-ESC-Events (required) Callback URL forESC eventnotifications

header string

internal_deployment_id (required) Internal ID of thedeployment (maxlength 72characters)

path string

body (required)

Parameter content type

applicationxml

ESC datamodel todeploy

body string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

503 Failed to query VIM

Implementation NotesUpdates an existing deployment Updates could be addition or removal of VM groups interfaces networks KPIsand Rules Day 0 config

After the service update operation is done ESC will send a callback to the client with the result

Example request of adding VM group

PUT v0deploymentsmy_dep_id HTTP11Content-Type applicationxmlAccept applicationxmlCallback http1270019010Callback-ESC-Events http1270019010

Body

ltesc_datamodel xmlnsns2=urnietfparamsxmlnsnetconfnotification10 xmlns=httpwwwciscocomescesc lttenantsgt lttenantgt ltnamegtadminltnamegt ltdeploymentsgt ltdeploymentgt ltnamegtMyDemoDepNameltnamegt ltvm_groupgt ltnamegtASA-1ltnamegt ltbootup_timegt300ltbootup_timegt ltrecovery_wait_timegt0ltrecovery_wait_timegt ltimagegtASAltimagegt ltinterfacesgt ltinterfacegt ltnicidgt1ltnicidgt ltnetworkgtMgtNetworkltnetworkgt ltip_addressgt180016ltip_addressgt ltinterfacegt ltinterfacesgt ltscalinggt ltmin_activegt1ltmin_activegt ltmax_activegt1ltmax_activegt ltelasticgttrueltelasticgt ltstatic_ip_address_poolgt ltnetworkgtMgtNetworkltnetworkgt ltip_addressgt180016ltip_addressgt ltstatic_ip_address_poolgt ltscalinggt ltkpi_datagt ltkpigt ltevent_namegtVM_ALIVEltevent_namegt ltmetric_valuegt1ltmetric_valuegt ltmetric_condgtGTltmetric_condgt ltmetric_typegtUINT32ltmetric_typegt ltmetric_collectorgt lttypegtICMPPinglttypegt ltnicidgt1ltnicidgt ltpoll_frequencygt3ltpoll_frequencygt ltpolling_unitgtsecondsltpolling_unitgt

ltcontinuous_alarmgtfalseltcontinuous_alarmgt ltmetric_collectorgtltkpigt ltkpi_datagt ltrulesgt ltadmin_rulesgt ltrulegt ltevent_namegtVM_ALIVEltevent_namegt ltactiongtALWAYS logltactiongt ltactiongtTRUE esc_vm_alive_notificationltactiongt ltrulegt ltadmin_rulesgt ltrulesgt ltconfig_datagt ltconfigurationgt ltdstgtday0-configltdstgt ltfilegthttpMY_FILE_SERVER_IPshareimagesday0-configASAvltfilegt ltconfigurationgt ltconfigurationgt ltdstgtidtokenltdstgt ltfilegthttpMY_FILE_SERVER_IPshareimagesasa-smartconfigltfilegt ltconfigurationgt ltconfig_datagt ltplacementgt lttypegtzone_hostlttypegt ltzonegtMY_CLUSTER1ltzonegt ltplacementgt ltvolumesgt ltvolumegt ltnamegtMY_DATASTORE1ltnamegt ltvolidgt1ltvolidgt ltvolumegt ltvolumesgt ltvm_groupgt ltnamegtCSR-1ltnamegt ltbootup_timegt300ltbootup_timegt ltrecovery_wait_timegt0ltrecovery_wait_timegt ltimagegtASAltimagegt ltinterfacesgt ltinterfacegt ltnicidgt1ltnicidgt ltnetworkgtMgtNetworkltnetworkgt ltip_addressgt180016ltip_addressgt ltinterfacegt ltinterfacesgt ltscalinggt ltmin_activegt1ltmin_activegt ltmax_activegt1ltmax_activegt ltelasticgttrueltelasticgt

ltstatic_ip_address_poolgt ltnetworkgtMgtNetworkltnetworkgt ltip_addressgt180016ltip_addressgt ltstatic_ip_address_poolgt ltscalinggt ltkpi_datagt ltkpigt ltevent_namegtVM_ALIVEltevent_namegt ltmetric_valuegt1ltmetric_valuegt ltmetric_condgtGTltmetric_condgt ltmetric_typegtUINT32ltmetric_typegt ltmetric_collectorgt lttypegtICMPPinglttypegt ltnicidgt1ltnicidgt ltpoll_frequencygt3ltpoll_frequencygt ltpolling_unitgtsecondsltpolling_unitgt ltcontinuous_alarmgtfalseltcontinuous_alarmgt ltmetric_collectorgtltkpigt ltkpi_datagt ltrulesgt ltadmin_rulesgt ltrulegt ltevent_namegtVM_ALIVEltevent_namegt ltactiongtALWAYS logltactiongt ltactiongtTRUE esc_vm_alive_notificationltactiongt ltrulegt ltadmin_rulesgt ltrulesgt ltconfig_datagt ltconfigurationgt ltdstgtday0-configltdstgt ltfilegthttpMY_FILE_SERVER_IPshareimagesday0-configASAvltfilegt ltconfigurationgt ltconfigurationgt ltdstgtidtokenltdstgt ltfilegthttpMY_FILE_SERVER_IPshareimagesasa-smartconfigltfilegt ltconfigurationgt ltconfig_datagt ltplacementgt lttypegtzone_hostlttypegt ltzonegtMY_CLUSTER1ltzonegt ltplacementgt ltvolumesgt ltvolumegt ltnamegtMY_DATASTORE1ltnamegt ltvolidgt1ltvolidgt ltvolumegt ltvolumesgt

ltdeploymentgt ltdeploymentsgt lttenantgt lttenantsgt ltesc_datamodelgt

While the Deployment Update operation is being processed successfully ESC will send a VM_DEPLOYEDcallback for each VM created on the VIM as part of this update request

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message VM Deployed

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_detailsgt lthost_uuidgthost-14882lthost_uuidgt lthost_namegt108510313lthost_namegt ltvm_uuidgt50217d2d-8afb-41c2-cffd-d76b1239f51eltvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgtMgtNetworkltnetwork_uuidgt ltip_addressgt180017ltip_addressgt ltmac_addressgt005056a16a13ltmac_addressgt ltnic_idgt1ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtCSR-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_INERT_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_DEPLOYEDltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477adltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_DEPLOYING_STATEltservice_state_machine_stategt

ltdeploymentgt

While the Deployment Update operation is being processed successfully ESC will send a VM_ALIVE callbackfor each monitorablepingable VM on the VIM created as part of this update request

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message VM_Alive event received VM ID [Sanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758d]

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_detailsgt lthost_uuidgthost-14882lthost_uuidgt lthost_namegt108510313lthost_namegt ltvm_uuidgt50217d2d-8afb-41c2-cffd-d76b1239f51eltvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgtMgtNetworkltnetwork_uuidgt ltip_addressgt180017ltip_addressgt ltmac_addressgt005056a16a13ltmac_addressgt ltnic_idgt1ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtCSR-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_ALIVE_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_ALIVEltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_INERT_STATEltservice_state_machine_stategt ltdeploymentgt

After the Deployment Update operation is done ESC will send a SERVICE_UPDATED callback to the client withthe result

Example callback

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message Service group update completed successfully

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtSERVICE_UPDATEDltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_ACTIVE_STATEltservice_state_machine_stategt ltdeploymentgt

If a VM specific resource like interface is updated then a VM_UPDATED followed by a SERVICE_UPDATEDnotification is received

Example callback

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message VM has been updated successfully vm VM ID [Sanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758d]

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_detailsgt lthost_uuidgthost-14882lthost_uuidgt lthost_namegt108510313lthost_namegt ltvm_uuidgt50217d2d-8afb-41c2-cffd-d76b1239f51eltvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgtMgtNetworkltnetwork_uuidgt ltip_addressgt180017ltip_addressgt ltmac_addressgt005056a16a13ltmac_addressgt ltnic_idgt1ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt

ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacegt ltnetwork_uuidgtMgtNetwork2ltnetwork_uuidgt ltip_addressgt180118ltip_addressgt ltmac_addressgt005056a16b14ltmac_addressgt ltnic_idgt2ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtCSR-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_ALIVE_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_ALIVEltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_INERT_STATEltservice_state_machine_stategt ltdeploymentgt

Followed by

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message Service group update completed successfully

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtSERVICE_UPDATEDltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_ACTIVE_STATEltservice_state_machine_stategt ltdeploymentgt

Try it out

07-Deployment Operations Operations to a deploymentPOST v0internal_tenant_iddeploymentsserviceinternal_deployment_id

Handle deployment operation request with the operation type as payload

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

Callback-ESC-Events (required) Callback URL forESC eventnotifications

header string

internal_deployment_id (required) Internal ID of thedeployment (maxlength 72characters)

path string

body

Parameter content type

applicationxml

body string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

ltcontinuous_alarmgtfalseltcontinuous_alarmgt ltmetric_collectorgtltkpigt ltkpi_datagt ltrulesgt ltadmin_rulesgt ltrulegt ltevent_namegtVM_ALIVEltevent_namegt ltactiongtALWAYS logltactiongt ltactiongtTRUE esc_vm_alive_notificationltactiongt ltrulegt ltadmin_rulesgt ltrulesgt ltconfig_datagt ltconfigurationgt ltdstgtday0-configltdstgt ltfilegthttpMY_FILE_SERVER_IPshareimagesday0-configASAvltfilegt ltconfigurationgt ltconfigurationgt ltdstgtidtokenltdstgt ltfilegthttpMY_FILE_SERVER_IPshareimagesasa-smartconfigltfilegt ltconfigurationgt ltconfig_datagt ltplacementgt lttypegtzone_hostlttypegt ltzonegtMY_CLUSTER1ltzonegt ltplacementgt ltvolumesgt ltvolumegt ltnamegtMY_DATASTORE1ltnamegt ltvolidgt1ltvolidgt ltvolumegt ltvolumesgt ltvm_groupgt ltnamegtCSR-1ltnamegt ltbootup_timegt300ltbootup_timegt ltrecovery_wait_timegt0ltrecovery_wait_timegt ltimagegtASAltimagegt ltinterfacesgt ltinterfacegt ltnicidgt1ltnicidgt ltnetworkgtMgtNetworkltnetworkgt ltip_addressgt180016ltip_addressgt ltinterfacegt ltinterfacesgt ltscalinggt ltmin_activegt1ltmin_activegt ltmax_activegt1ltmax_activegt ltelasticgttrueltelasticgt

ltstatic_ip_address_poolgt ltnetworkgtMgtNetworkltnetworkgt ltip_addressgt180016ltip_addressgt ltstatic_ip_address_poolgt ltscalinggt ltkpi_datagt ltkpigt ltevent_namegtVM_ALIVEltevent_namegt ltmetric_valuegt1ltmetric_valuegt ltmetric_condgtGTltmetric_condgt ltmetric_typegtUINT32ltmetric_typegt ltmetric_collectorgt lttypegtICMPPinglttypegt ltnicidgt1ltnicidgt ltpoll_frequencygt3ltpoll_frequencygt ltpolling_unitgtsecondsltpolling_unitgt ltcontinuous_alarmgtfalseltcontinuous_alarmgt ltmetric_collectorgtltkpigt ltkpi_datagt ltrulesgt ltadmin_rulesgt ltrulegt ltevent_namegtVM_ALIVEltevent_namegt ltactiongtALWAYS logltactiongt ltactiongtTRUE esc_vm_alive_notificationltactiongt ltrulegt ltadmin_rulesgt ltrulesgt ltconfig_datagt ltconfigurationgt ltdstgtday0-configltdstgt ltfilegthttpMY_FILE_SERVER_IPshareimagesday0-configASAvltfilegt ltconfigurationgt ltconfigurationgt ltdstgtidtokenltdstgt ltfilegthttpMY_FILE_SERVER_IPshareimagesasa-smartconfigltfilegt ltconfigurationgt ltconfig_datagt ltplacementgt lttypegtzone_hostlttypegt ltzonegtMY_CLUSTER1ltzonegt ltplacementgt ltvolumesgt ltvolumegt ltnamegtMY_DATASTORE1ltnamegt ltvolidgt1ltvolidgt ltvolumegt ltvolumesgt

ltdeploymentgt ltdeploymentsgt lttenantgt lttenantsgt ltesc_datamodelgt

While the Deployment Update operation is being processed successfully ESC will send a VM_DEPLOYEDcallback for each VM created on the VIM as part of this update request

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message VM Deployed

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_detailsgt lthost_uuidgthost-14882lthost_uuidgt lthost_namegt108510313lthost_namegt ltvm_uuidgt50217d2d-8afb-41c2-cffd-d76b1239f51eltvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgtMgtNetworkltnetwork_uuidgt ltip_addressgt180017ltip_addressgt ltmac_addressgt005056a16a13ltmac_addressgt ltnic_idgt1ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtCSR-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_INERT_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_DEPLOYEDltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477adltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_DEPLOYING_STATEltservice_state_machine_stategt

ltdeploymentgt

While the Deployment Update operation is being processed successfully ESC will send a VM_ALIVE callbackfor each monitorablepingable VM on the VIM created as part of this update request

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message VM_Alive event received VM ID [Sanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758d]

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_detailsgt lthost_uuidgthost-14882lthost_uuidgt lthost_namegt108510313lthost_namegt ltvm_uuidgt50217d2d-8afb-41c2-cffd-d76b1239f51eltvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgtMgtNetworkltnetwork_uuidgt ltip_addressgt180017ltip_addressgt ltmac_addressgt005056a16a13ltmac_addressgt ltnic_idgt1ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtCSR-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_ALIVE_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_ALIVEltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_INERT_STATEltservice_state_machine_stategt ltdeploymentgt

After the Deployment Update operation is done ESC will send a SERVICE_UPDATED callback to the client withthe result

Example callback

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message Service group update completed successfully

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtSERVICE_UPDATEDltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_ACTIVE_STATEltservice_state_machine_stategt ltdeploymentgt

If a VM specific resource like interface is updated then a VM_UPDATED followed by a SERVICE_UPDATEDnotification is received

Example callback

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message VM has been updated successfully vm VM ID [Sanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758d]

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_detailsgt lthost_uuidgthost-14882lthost_uuidgt lthost_namegt108510313lthost_namegt ltvm_uuidgt50217d2d-8afb-41c2-cffd-d76b1239f51eltvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgtMgtNetworkltnetwork_uuidgt ltip_addressgt180017ltip_addressgt ltmac_addressgt005056a16a13ltmac_addressgt ltnic_idgt1ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt

ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacegt ltnetwork_uuidgtMgtNetwork2ltnetwork_uuidgt ltip_addressgt180118ltip_addressgt ltmac_addressgt005056a16b14ltmac_addressgt ltnic_idgt2ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtCSR-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_ALIVE_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_ALIVEltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_INERT_STATEltservice_state_machine_stategt ltdeploymentgt

Followed by

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message Service group update completed successfully

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtSERVICE_UPDATEDltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_ACTIVE_STATEltservice_state_machine_stategt ltdeploymentgt

Try it out

07-Deployment Operations Operations to a deploymentPOST v0internal_tenant_iddeploymentsserviceinternal_deployment_id

Handle deployment operation request with the operation type as payload

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

Callback-ESC-Events (required) Callback URL forESC eventnotifications

header string

internal_deployment_id (required) Internal ID of thedeployment (maxlength 72characters)

path string

body

Parameter content type

applicationxml

body string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

ltstatic_ip_address_poolgt ltnetworkgtMgtNetworkltnetworkgt ltip_addressgt180016ltip_addressgt ltstatic_ip_address_poolgt ltscalinggt ltkpi_datagt ltkpigt ltevent_namegtVM_ALIVEltevent_namegt ltmetric_valuegt1ltmetric_valuegt ltmetric_condgtGTltmetric_condgt ltmetric_typegtUINT32ltmetric_typegt ltmetric_collectorgt lttypegtICMPPinglttypegt ltnicidgt1ltnicidgt ltpoll_frequencygt3ltpoll_frequencygt ltpolling_unitgtsecondsltpolling_unitgt ltcontinuous_alarmgtfalseltcontinuous_alarmgt ltmetric_collectorgtltkpigt ltkpi_datagt ltrulesgt ltadmin_rulesgt ltrulegt ltevent_namegtVM_ALIVEltevent_namegt ltactiongtALWAYS logltactiongt ltactiongtTRUE esc_vm_alive_notificationltactiongt ltrulegt ltadmin_rulesgt ltrulesgt ltconfig_datagt ltconfigurationgt ltdstgtday0-configltdstgt ltfilegthttpMY_FILE_SERVER_IPshareimagesday0-configASAvltfilegt ltconfigurationgt ltconfigurationgt ltdstgtidtokenltdstgt ltfilegthttpMY_FILE_SERVER_IPshareimagesasa-smartconfigltfilegt ltconfigurationgt ltconfig_datagt ltplacementgt lttypegtzone_hostlttypegt ltzonegtMY_CLUSTER1ltzonegt ltplacementgt ltvolumesgt ltvolumegt ltnamegtMY_DATASTORE1ltnamegt ltvolidgt1ltvolidgt ltvolumegt ltvolumesgt

ltdeploymentgt ltdeploymentsgt lttenantgt lttenantsgt ltesc_datamodelgt

While the Deployment Update operation is being processed successfully ESC will send a VM_DEPLOYEDcallback for each VM created on the VIM as part of this update request

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message VM Deployed

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_detailsgt lthost_uuidgthost-14882lthost_uuidgt lthost_namegt108510313lthost_namegt ltvm_uuidgt50217d2d-8afb-41c2-cffd-d76b1239f51eltvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgtMgtNetworkltnetwork_uuidgt ltip_addressgt180017ltip_addressgt ltmac_addressgt005056a16a13ltmac_addressgt ltnic_idgt1ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtCSR-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_INERT_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_DEPLOYEDltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477adltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_DEPLOYING_STATEltservice_state_machine_stategt

ltdeploymentgt

While the Deployment Update operation is being processed successfully ESC will send a VM_ALIVE callbackfor each monitorablepingable VM on the VIM created as part of this update request

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message VM_Alive event received VM ID [Sanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758d]

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_detailsgt lthost_uuidgthost-14882lthost_uuidgt lthost_namegt108510313lthost_namegt ltvm_uuidgt50217d2d-8afb-41c2-cffd-d76b1239f51eltvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgtMgtNetworkltnetwork_uuidgt ltip_addressgt180017ltip_addressgt ltmac_addressgt005056a16a13ltmac_addressgt ltnic_idgt1ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtCSR-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_ALIVE_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_ALIVEltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_INERT_STATEltservice_state_machine_stategt ltdeploymentgt

After the Deployment Update operation is done ESC will send a SERVICE_UPDATED callback to the client withthe result

Example callback

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message Service group update completed successfully

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtSERVICE_UPDATEDltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_ACTIVE_STATEltservice_state_machine_stategt ltdeploymentgt

If a VM specific resource like interface is updated then a VM_UPDATED followed by a SERVICE_UPDATEDnotification is received

Example callback

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message VM has been updated successfully vm VM ID [Sanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758d]

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_detailsgt lthost_uuidgthost-14882lthost_uuidgt lthost_namegt108510313lthost_namegt ltvm_uuidgt50217d2d-8afb-41c2-cffd-d76b1239f51eltvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgtMgtNetworkltnetwork_uuidgt ltip_addressgt180017ltip_addressgt ltmac_addressgt005056a16a13ltmac_addressgt ltnic_idgt1ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt

ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacegt ltnetwork_uuidgtMgtNetwork2ltnetwork_uuidgt ltip_addressgt180118ltip_addressgt ltmac_addressgt005056a16b14ltmac_addressgt ltnic_idgt2ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtCSR-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_ALIVE_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_ALIVEltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_INERT_STATEltservice_state_machine_stategt ltdeploymentgt

Followed by

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message Service group update completed successfully

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtSERVICE_UPDATEDltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_ACTIVE_STATEltservice_state_machine_stategt ltdeploymentgt

Try it out

07-Deployment Operations Operations to a deploymentPOST v0internal_tenant_iddeploymentsserviceinternal_deployment_id

Handle deployment operation request with the operation type as payload

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

Callback-ESC-Events (required) Callback URL forESC eventnotifications

header string

internal_deployment_id (required) Internal ID of thedeployment (maxlength 72characters)

path string

body

Parameter content type

applicationxml

body string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

ltdeploymentgt ltdeploymentsgt lttenantgt lttenantsgt ltesc_datamodelgt

While the Deployment Update operation is being processed successfully ESC will send a VM_DEPLOYEDcallback for each VM created on the VIM as part of this update request

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message VM Deployed

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_detailsgt lthost_uuidgthost-14882lthost_uuidgt lthost_namegt108510313lthost_namegt ltvm_uuidgt50217d2d-8afb-41c2-cffd-d76b1239f51eltvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgtMgtNetworkltnetwork_uuidgt ltip_addressgt180017ltip_addressgt ltmac_addressgt005056a16a13ltmac_addressgt ltnic_idgt1ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtCSR-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_INERT_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_DEPLOYEDltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477adltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_DEPLOYING_STATEltservice_state_machine_stategt

ltdeploymentgt

While the Deployment Update operation is being processed successfully ESC will send a VM_ALIVE callbackfor each monitorablepingable VM on the VIM created as part of this update request

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message VM_Alive event received VM ID [Sanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758d]

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_detailsgt lthost_uuidgthost-14882lthost_uuidgt lthost_namegt108510313lthost_namegt ltvm_uuidgt50217d2d-8afb-41c2-cffd-d76b1239f51eltvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgtMgtNetworkltnetwork_uuidgt ltip_addressgt180017ltip_addressgt ltmac_addressgt005056a16a13ltmac_addressgt ltnic_idgt1ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtCSR-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_ALIVE_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_ALIVEltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_INERT_STATEltservice_state_machine_stategt ltdeploymentgt

After the Deployment Update operation is done ESC will send a SERVICE_UPDATED callback to the client withthe result

Example callback

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message Service group update completed successfully

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtSERVICE_UPDATEDltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_ACTIVE_STATEltservice_state_machine_stategt ltdeploymentgt

If a VM specific resource like interface is updated then a VM_UPDATED followed by a SERVICE_UPDATEDnotification is received

Example callback

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message VM has been updated successfully vm VM ID [Sanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758d]

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_detailsgt lthost_uuidgthost-14882lthost_uuidgt lthost_namegt108510313lthost_namegt ltvm_uuidgt50217d2d-8afb-41c2-cffd-d76b1239f51eltvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgtMgtNetworkltnetwork_uuidgt ltip_addressgt180017ltip_addressgt ltmac_addressgt005056a16a13ltmac_addressgt ltnic_idgt1ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt

ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacegt ltnetwork_uuidgtMgtNetwork2ltnetwork_uuidgt ltip_addressgt180118ltip_addressgt ltmac_addressgt005056a16b14ltmac_addressgt ltnic_idgt2ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtCSR-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_ALIVE_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_ALIVEltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_INERT_STATEltservice_state_machine_stategt ltdeploymentgt

Followed by

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message Service group update completed successfully

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtSERVICE_UPDATEDltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_ACTIVE_STATEltservice_state_machine_stategt ltdeploymentgt

Try it out

07-Deployment Operations Operations to a deploymentPOST v0internal_tenant_iddeploymentsserviceinternal_deployment_id

Handle deployment operation request with the operation type as payload

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

Callback-ESC-Events (required) Callback URL forESC eventnotifications

header string

internal_deployment_id (required) Internal ID of thedeployment (maxlength 72characters)

path string

body

Parameter content type

applicationxml

body string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

ltdeploymentgt

While the Deployment Update operation is being processed successfully ESC will send a VM_ALIVE callbackfor each monitorablepingable VM on the VIM created as part of this update request

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message VM_Alive event received VM ID [Sanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758d]

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_detailsgt lthost_uuidgthost-14882lthost_uuidgt lthost_namegt108510313lthost_namegt ltvm_uuidgt50217d2d-8afb-41c2-cffd-d76b1239f51eltvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgtMgtNetworkltnetwork_uuidgt ltip_addressgt180017ltip_addressgt ltmac_addressgt005056a16a13ltmac_addressgt ltnic_idgt1ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtCSR-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_ALIVE_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_ALIVEltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_INERT_STATEltservice_state_machine_stategt ltdeploymentgt

After the Deployment Update operation is done ESC will send a SERVICE_UPDATED callback to the client withthe result

Example callback

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message Service group update completed successfully

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtSERVICE_UPDATEDltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_ACTIVE_STATEltservice_state_machine_stategt ltdeploymentgt

If a VM specific resource like interface is updated then a VM_UPDATED followed by a SERVICE_UPDATEDnotification is received

Example callback

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message VM has been updated successfully vm VM ID [Sanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758d]

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_detailsgt lthost_uuidgthost-14882lthost_uuidgt lthost_namegt108510313lthost_namegt ltvm_uuidgt50217d2d-8afb-41c2-cffd-d76b1239f51eltvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgtMgtNetworkltnetwork_uuidgt ltip_addressgt180017ltip_addressgt ltmac_addressgt005056a16a13ltmac_addressgt ltnic_idgt1ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt

ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacegt ltnetwork_uuidgtMgtNetwork2ltnetwork_uuidgt ltip_addressgt180118ltip_addressgt ltmac_addressgt005056a16b14ltmac_addressgt ltnic_idgt2ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtCSR-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_ALIVE_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_ALIVEltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_INERT_STATEltservice_state_machine_stategt ltdeploymentgt

Followed by

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message Service group update completed successfully

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtSERVICE_UPDATEDltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_ACTIVE_STATEltservice_state_machine_stategt ltdeploymentgt

Try it out

07-Deployment Operations Operations to a deploymentPOST v0internal_tenant_iddeploymentsserviceinternal_deployment_id

Handle deployment operation request with the operation type as payload

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

Callback-ESC-Events (required) Callback URL forESC eventnotifications

header string

internal_deployment_id (required) Internal ID of thedeployment (maxlength 72characters)

path string

body

Parameter content type

applicationxml

body string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

Example callback

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message Service group update completed successfully

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtSERVICE_UPDATEDltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_ACTIVE_STATEltservice_state_machine_stategt ltdeploymentgt

If a VM specific resource like interface is updated then a VM_UPDATED followed by a SERVICE_UPDATEDnotification is received

Example callback

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message VM has been updated successfully vm VM ID [Sanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758d]

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_detailsgt lthost_uuidgthost-14882lthost_uuidgt lthost_namegt108510313lthost_namegt ltvm_uuidgt50217d2d-8afb-41c2-cffd-d76b1239f51eltvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgtMgtNetworkltnetwork_uuidgt ltip_addressgt180017ltip_addressgt ltmac_addressgt005056a16a13ltmac_addressgt ltnic_idgt1ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt

ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacegt ltnetwork_uuidgtMgtNetwork2ltnetwork_uuidgt ltip_addressgt180118ltip_addressgt ltmac_addressgt005056a16b14ltmac_addressgt ltnic_idgt2ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtCSR-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_ALIVE_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_ALIVEltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_INERT_STATEltservice_state_machine_stategt ltdeploymentgt

Followed by

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message Service group update completed successfully

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtSERVICE_UPDATEDltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_ACTIVE_STATEltservice_state_machine_stategt ltdeploymentgt

Try it out

07-Deployment Operations Operations to a deploymentPOST v0internal_tenant_iddeploymentsserviceinternal_deployment_id

Handle deployment operation request with the operation type as payload

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

Callback-ESC-Events (required) Callback URL forESC eventnotifications

header string

internal_deployment_id (required) Internal ID of thedeployment (maxlength 72characters)

path string

body

Parameter content type

applicationxml

body string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacegt ltnetwork_uuidgtMgtNetwork2ltnetwork_uuidgt ltip_addressgt180118ltip_addressgt ltmac_addressgt005056a16b14ltmac_addressgt ltnic_idgt2ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgtltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgtltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt ltinterfacesgt ltvm_group_namegtCSR-1ltvm_group_namegt ltvm_namegtSanity-vmware-de_CSR-1_0_b323effd-7f70-4055-b11e-0ef66f0a758dltvm_namegt ltvm_state_machine_stategtVM_ALIVE_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtVM_ALIVEltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_INERT_STATEltservice_state_machine_stategt ltdeploymentgt

Followed by

HTTP11 201 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID d53f0047-2315-466c-b7e3-aa78e0a567e8ESC-Status-Code 200ESC-Status-Message Service group update completed successfully

ltxml version=10 encoding=UTF-8 standalone=yesgt ltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergtltdefaultgtfalseltdefaultgtltdatacentergt ltdeployment_namegtMyDemoDepNameltdeployment_namegt ltdeployment_stagegtSERVICE_UPDATEDltdeployment_stagegt ltexternal_deployment_idgt8d084aab-6a66-4a70-8f47-42b91f7477acltexternal_deployment_idgt ltexternal_tenant_idgtSystemAdminTenantIdltexternal_tenant_idgt ltinternal_deployment_idgtmy_dep_idltinternal_deployment_idgt ltinternal_tenant_idgtSystemAdminTenantIdltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_ACTIVE_STATEltservice_state_machine_stategt ltdeploymentgt

Try it out

07-Deployment Operations Operations to a deploymentPOST v0internal_tenant_iddeploymentsserviceinternal_deployment_id

Handle deployment operation request with the operation type as payload

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

Callback-ESC-Events (required) Callback URL forESC eventnotifications

header string

internal_deployment_id (required) Internal ID of thedeployment (maxlength 72characters)

path string

body

Parameter content type

applicationxml

body string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

Try it out

07-Deployment Operations Operations to a deploymentPOST v0internal_tenant_iddeploymentsserviceinternal_deployment_id

Handle deployment operation request with the operation type as payload

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

Callback-ESC-Events (required) Callback URL forESC eventnotifications

header string

internal_deployment_id (required) Internal ID of thedeployment (maxlength 72characters)

path string

body

Parameter content type

applicationxml

body string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

Implementation NotesPerforms actions like stop start reboot disable_monitoring or enable_monitoring on a deployment Examplerequest

POST v0tenantstest-tenant1deploymentsvmtest-dep1-cirros_overid_0_cfeefcee-a1fe-4e94-9ffc-81792b265788 HTTP11Content-Type applicationxmlAccept applicationjsonCallback http1270019010

Bodyltservice_operation xmlns=urnietfparamsxmlnsnetconfbase10gt ltoperationgtstopltoperationgtltservice_operationgt

While the stop deployment operation is being performed ESC will send a VM_STOPPED callback to the clientfor each VM stopped as part of this request Example callback

HTTP11 200 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID 5e47b5ff-bc59-4ece-b15b-8941910def74ESC-Status-Code 200ESC-Status-Message VM successfully stopped

ltxml version=10 encoding=UTF-8 standalone=yesgtltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergt ltdefaultgtfalseltdefaultgt ltdatacentergt ltdeployment_detailsgt lthost_uuidgt17be6eae40795ec068ce77a05fcb1c47f7ac42dfba160261719d4087lthost_uuidgt lthost_namegtmy-ucs-3lthost_namegt ltvm_uuidgtcb86a952-c030-46f6-96f6-e81069bcea3altvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgt943fda9e-79f8-400c-b442-3506f102721altnetwork_uuidgt ltgatewaygt19216801ltgatewaygt ltip_addressgt1921680135ltip_addressgt ltmac_addressgtfa163e3c17b0ltmac_addressgt ltnetmaskgt2552552550ltnetmaskgt ltnic_idgt0ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgt263eaf20-2662-4a6b-a1f1-ed76001a1b5cltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgte313b95c-ca1f-4c81-8d60-c9e721a85d0bltsubnet_uuidgt lttypegtvirtuallttypegt

ltinterfacegt ltinterfacesgt ltvm_group_namegtoveridegrp2ltvm_group_namegt ltvm_namegttest-dep1-cirros_overid_0_cfeefcee-a1fe-4e94-9ffc-81792b265788ltvm_namegt ltvm_state_machine_stategtVM_SHUTOFF_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegttest-dep1-cirrosltdeployment_namegt ltdeployment_stagegtVM_STOPPEDltdeployment_stagegt ltexternal_deployment_idgt5c278010-ad0f-4e29-bdce-f4b6c6946c38ltexternal_deployment_idgt ltexternal_tenant_idgt29f2cd7934dc4311ad3a34d72d1ab7b8ltexternal_tenant_idgt ltinternal_deployment_idgttest-tenant1test-dep1-cirrosltinternal_deployment_idgt ltinternal_tenant_idgttest-tenant1ltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_STOPPED_STATEltservice_state_machine_stategtltdeploymentgt

After the stop deployment operation is done successfully ESC will send a SERVICE_STOPPED callback to theclient with the result Example callback

HTTP11 200 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID 5e47b5ff-bc59-4ece-b15b-8941910def74ESC-Status-Code 200ESC-Status-Message Service group suspension completed successfully

ltxml version=10 encoding=UTF-8 standalone=yesgtltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergt ltdefaultgtfalseltdefaultgt ltdatacentergt ltdeployment_detailsgt lthost_uuidgt17be6eae40795ec068ce77a05fcb1c47f7ac42dfba160261719d4087lthost_uuidgt lthost_namegtmy-ucs-3lthost_namegt ltvm_uuidgtcb86a952-c030-46f6-96f6-e81069bcea3altvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgt943fda9e-79f8-400c-b442-3506f102721altnetwork_uuidgt ltgatewaygt19216801ltgatewaygt ltip_addressgt1921680135ltip_addressgt ltmac_addressgtfa163e3c17b0ltmac_addressgt ltnetmaskgt2552552550ltnetmaskgt ltnic_idgt0ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgt263eaf20-2662-4a6b-a1f1-ed76001a1b5cltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgte313b95c-ca1f-4c81-8d60-c9e721a85d0bltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt

Model Model Schema

ltinterfacesgt ltvm_group_namegtoveridegrp2ltvm_group_namegt ltvm_namegttest-dep1-cirros_overid_0_cfeefcee-a1fe-4e94-9ffc-81792b265788ltvm_namegt ltvm_state_machine_stategtVM_SHUTOFF_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegttest-dep1-cirrosltdeployment_namegt ltdeployment_stagegtSERVICE_STOPPEDltdeployment_stagegt ltexternal_deployment_idgt5c278010-ad0f-4e29-bdce-f4b6c6946c38ltexternal_deployment_idgt ltexternal_tenant_idgt29f2cd7934dc4311ad3a34d72d1ab7b8ltexternal_tenant_idgt ltinternal_deployment_idgttest-tenant1test-dep1-cirrosltinternal_deployment_idgt ltinternal_tenant_idgttest-tenant1ltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_STOPPED_STATEltservice_state_machine_stategtltdeploymentgt

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URLfor ESCnotifications

header string

internal_tenant_id (required) Internal tenantID (max length72 characters)

path string

internal_deployment_id (required) Internaldeployment ID(max length 72characters)

path string

body (required)

Parameter content type

applicationxml

Deploymentoperationpayloadspecifying thetype ofoperation

body

operation stop

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Deployment operationrequest accepted

400 Missing callback or

ltinterfacegt ltinterfacesgt ltvm_group_namegtoveridegrp2ltvm_group_namegt ltvm_namegttest-dep1-cirros_overid_0_cfeefcee-a1fe-4e94-9ffc-81792b265788ltvm_namegt ltvm_state_machine_stategtVM_SHUTOFF_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegttest-dep1-cirrosltdeployment_namegt ltdeployment_stagegtVM_STOPPEDltdeployment_stagegt ltexternal_deployment_idgt5c278010-ad0f-4e29-bdce-f4b6c6946c38ltexternal_deployment_idgt ltexternal_tenant_idgt29f2cd7934dc4311ad3a34d72d1ab7b8ltexternal_tenant_idgt ltinternal_deployment_idgttest-tenant1test-dep1-cirrosltinternal_deployment_idgt ltinternal_tenant_idgttest-tenant1ltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_STOPPED_STATEltservice_state_machine_stategtltdeploymentgt

After the stop deployment operation is done successfully ESC will send a SERVICE_STOPPED callback to theclient with the result Example callback

HTTP11 200 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID 5e47b5ff-bc59-4ece-b15b-8941910def74ESC-Status-Code 200ESC-Status-Message Service group suspension completed successfully

ltxml version=10 encoding=UTF-8 standalone=yesgtltdeployment xmlns=urnietfparamsxmlnsnetconfbase10gt ltdatacentergt ltdefaultgtfalseltdefaultgt ltdatacentergt ltdeployment_detailsgt lthost_uuidgt17be6eae40795ec068ce77a05fcb1c47f7ac42dfba160261719d4087lthost_uuidgt lthost_namegtmy-ucs-3lthost_namegt ltvm_uuidgtcb86a952-c030-46f6-96f6-e81069bcea3altvm_uuidgt ltinterfacesgt ltinterfacegt ltnetwork_uuidgt943fda9e-79f8-400c-b442-3506f102721altnetwork_uuidgt ltgatewaygt19216801ltgatewaygt ltip_addressgt1921680135ltip_addressgt ltmac_addressgtfa163e3c17b0ltmac_addressgt ltnetmaskgt2552552550ltnetmaskgt ltnic_idgt0ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgt263eaf20-2662-4a6b-a1f1-ed76001a1b5cltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt ltsubnet_uuidgte313b95c-ca1f-4c81-8d60-c9e721a85d0bltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacegt

Model Model Schema

ltinterfacesgt ltvm_group_namegtoveridegrp2ltvm_group_namegt ltvm_namegttest-dep1-cirros_overid_0_cfeefcee-a1fe-4e94-9ffc-81792b265788ltvm_namegt ltvm_state_machine_stategtVM_SHUTOFF_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegttest-dep1-cirrosltdeployment_namegt ltdeployment_stagegtSERVICE_STOPPEDltdeployment_stagegt ltexternal_deployment_idgt5c278010-ad0f-4e29-bdce-f4b6c6946c38ltexternal_deployment_idgt ltexternal_tenant_idgt29f2cd7934dc4311ad3a34d72d1ab7b8ltexternal_tenant_idgt ltinternal_deployment_idgttest-tenant1test-dep1-cirrosltinternal_deployment_idgt ltinternal_tenant_idgttest-tenant1ltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_STOPPED_STATEltservice_state_machine_stategtltdeploymentgt

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URLfor ESCnotifications

header string

internal_tenant_id (required) Internal tenantID (max length72 characters)

path string

internal_deployment_id (required) Internaldeployment ID(max length 72characters)

path string

body (required)

Parameter content type

applicationxml

Deploymentoperationpayloadspecifying thetype ofoperation

body

operation stop

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Deployment operationrequest accepted

400 Missing callback or

Model Model Schema

ltinterfacesgt ltvm_group_namegtoveridegrp2ltvm_group_namegt ltvm_namegttest-dep1-cirros_overid_0_cfeefcee-a1fe-4e94-9ffc-81792b265788ltvm_namegt ltvm_state_machine_stategtVM_SHUTOFF_STATEltvm_state_machine_stategt ltdeployment_detailsgt ltdeployment_namegttest-dep1-cirrosltdeployment_namegt ltdeployment_stagegtSERVICE_STOPPEDltdeployment_stagegt ltexternal_deployment_idgt5c278010-ad0f-4e29-bdce-f4b6c6946c38ltexternal_deployment_idgt ltexternal_tenant_idgt29f2cd7934dc4311ad3a34d72d1ab7b8ltexternal_tenant_idgt ltinternal_deployment_idgttest-tenant1test-dep1-cirrosltinternal_deployment_idgt ltinternal_tenant_idgttest-tenant1ltinternal_tenant_idgt ltservice_state_machine_stategtSERVICE_STOPPED_STATEltservice_state_machine_stategtltdeploymentgt

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URLfor ESCnotifications

header string

internal_tenant_id (required) Internal tenantID (max length72 characters)

path string

internal_deployment_id (required) Internaldeployment ID(max length 72characters)

path string

body (required)

Parameter content type

applicationxml

Deploymentoperationpayloadspecifying thetype ofoperation

body

operation stop

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Deployment operationrequest accepted

400 Missing callback or

Try it out

08-VM Operations Operations to a VMPOST v0internal_tenant_iddeploymentsrecovery-vmvm_name

Handle recovery VM operation request with the operation type as payload

Model Model Schema

Try it out

POST v0internal_tenant_iddeploymentsvmvm_name

Deployment operation is notapplicable

404 Deployment or tenant notfound

Parameters

Parameter Value Description ParameterType Data Type

internal_tenant_id (required) Internal tenantID (max length72 characters)

path string

vm_name (required) VM name path string

body (required)

Parameter content type

applicationxml

Recovery VMoperationpayloadspecifying thetype ofoperationrecovery_do

body

operation string

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Recovery VM operationrequest accepted

400 Recovery VM operation is notapplicable

404 VM or tenant not found

Handle VM operation request with the operation type as payload

Implementation NotesPerforms actions like stop start reboot disable_monitoring or enable_monitoring on an existing VM managedby ESC Example request

POST v0tenantstest-tenant1deploymentsvmtest-dep1-cirros_overid_0_cfeefcee-a1fe-4e94-9ffc-81792b265788 HTTP11Content-Type applicationxmlAccept applicationjsonCallback http1270019010Callback-ESC-Events http1270019010

Bodyltvm_operation xmlns=urnietfparamsxmlnsnetconfbase10gt ltoperationgtstopltoperationgtltvm_operationgt

After the VM stop operation is done ESC will send a VM_STOP_COMPLETE callback to the client with theresult Example callback

HTTP11 200 OKContent-Type applicationxml charset=UTF-8ESC_TRANSACTION_ID 4546c40a-d6e3-4abe-a7e7-51afd4fc5362ESC-Status-Code 200ESC-Status-Message Successfully stopped VM [test-dep1-cirros_overid_0_cfeefcee-a1fe-4e94-9ffc-81792b265788]

ltxml version=10 encoding=UTF-8 standalone=yesgtltesc_event xmlns=urnietfparamsxmlnsnetconfbase10gt ltdeployment_namegttest-dep1-cirrosltdeployment_namegt ltevent_detailsgtltevent_detailsgt ltevent_typegtVM_STOP_COMPLETEltevent_typegt ltexternal_deployment_idgt5c278010-ad0f-4e29-bdce-f4b6c6946c38ltexternal_deployment_idgt ltexternal_tenant_idgt29f2cd7934dc4311ad3a34d72d1ab7b8ltexternal_tenant_idgt ltinternal_deployment_idgttest-tenant1test-dep1-cirrosltinternal_deployment_idgt ltinternal_tenant_idgttest-tenant1ltinternal_tenant_idgt ltvm_sourcegt ltinterfacesgt ltnetwork_uuidgt943fda9e-79f8-400c-b442-3506f102721altnetwork_uuidgt ltgatewaygt19216801ltgatewaygt ltip_addressgt1921680135ltip_addressgt ltmac_addressgtfa163e3c17b0ltmac_addressgt ltnetmaskgt2552552550ltnetmaskgt ltnic_idgt0ltnic_idgt ltport_forwardinggtltport_forwardinggt ltport_uuidgt263eaf20-2662-4a6b-a1f1-ed76001a1b5cltport_uuidgt ltsecurity_groupsgtltsecurity_groupsgt

Model Model Schema

Try it out

ltsubnet_uuidgte313b95c-ca1f-4c81-8d60-c9e721a85d0bltsubnet_uuidgt lttypegtvirtuallttypegt ltinterfacesgt lthost_uuidgt17be6eae40795ec068ce77a05fcb1c47f7ac42dfba160261719d4087lthost_uuidgt lthost_namegtmy-ucs-3lthost_namegt ltvm_uuidgtcb86a952-c030-46f6-96f6-e81069bcea3altvm_uuidgt ltvm_group_namegtoveridegrp2ltvm_group_namegt ltvm_namegttest-dep1-cirros_overid_0_cfeefcee-a1fe-4e94-9ffc-81792b265788ltvm_namegt ltvm_sourcegtltesc_eventgt

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URLfor notifications

header string

Callback-ESC-Events

(required) Callback URLfor ESC eventnotifications

header string

internal_tenant_id (required) Internal tenantID (max length72 characters)

path string

vm_name (required) VM name path string

body (required)

Parameter content type

applicationxml

VM operationpayloadspecifying thetype ofoperation

body

operation stop

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 VM operation requestaccepted

400 Missing callback or VMoperation is not applicable

404 VM or tenant not found

Try it out

09-Configuration ParametersGET v0config Retrive all ESC config parameters

Try it out

GET v0configcategory Retrive all ESC config parameters under a category

Try it out

GET v0configcategorykey Retrive a ESC config parameters under a category with a given key

Implementation NotesRetrive all ESC config parameters

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Get all parameters requestaccepted

Implementation NotesRetrive all ESC config parameters under a category

Parameters

Parameter Value Description ParameterType Data Type

category (required) ESC configparameter category

path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Get category requestaccepted

400 Invalid category nameprovided

404 Category not found

Try it out

POST v0configcategorykey Create a new key under a category

Model Model Schema

Implementation NotesRetrive a ESC config parameters under a category with a given key

Parameters

Parameter Value Description ParameterType Data Type

category (required) ESC configparameter category

path string

key (required) ESC configparameter key

path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Get key under categoryrequest accepted

400 Invalid key or category nameprovided

404 Key or category not found

Implementation NotesCreate a new key under a catgeory

Response Class (Status 200)

category DEFAULT key CONNECTION_RETRIES value type STRING

Response Content Type applicationxml

Parameters

Try it out

PUT v0configcategorykeyvalue Change an ESC config parameter under a category with a given key

Parameter Value Description ParameterType Data Type

category (required) ESC configparameter category

path string

key (required) ESC configparameter key

path string

body (required)

Parameter content type

applicationjson

ESC configparameter value

body string

Implementation NotesChange an ESC config parameter under a category with a given key

Format PUT v0configcategorykeyvalue

Example request

curl -X PUT -H accept Applicationxml http1270018080ESCManagerv0configlogleveldebug

Example response

ltxml version=10 encoding=UTF-8 standalone=yesgt ltescconfigparametergt ltcategorygtLOGltcategorygt ltkeygtLEVELltkeygt lttypegtSTRINGlttypegt ltvalue xmlnsxsi=httpwwww3org2001XMLSchema-instance xmlnsxs=httpwwww3org2001XMLSchema ltescconfigparametergt

Details of Config Parameters Please refer to installation and user guide for more details

Category DEFAULT Key VM_RECOVERY_RETRIES_MAX Default Value 3 Type Int Description Number ofmaximum recovery attempts allowed per VM

Category OPENSTACK Key ENDPOINT Default Value adminURL Type String Description The parameter to

Try it out

10-Dynamic MappingsDELETE v0internaldynamic_mappingactions Delete all non-CORE dynamic mapping actions from ESC

set up the keystone endpoint value of ESC Options adminURL publicURL

Category LOG Key LEVEL Default Value INFO Type String Description Level of logging of ESCManagerOptions INFO TRACE DEBUG

Category AFFINITY Key FILTER Default Value SameHostFilter Type String Description A constant stringused to build PolicyEngine and initializing VM policy table Options SameHostFilter ServerGroupAffinity

Category ANTI-AFFINITY Key FILTER Default Value DifferentHostFilter Type String Description A constantstring used to build PolicyEngine and initializing VM policy table Options DifferentHostFilterServerGroupAffinity

Parameters

Parameter Value Description ParameterType Data Type

category (required) ESC configparameter category

path string

key (required) ESC configparameter key

path string

value (required) ESC configparameter value

path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Update value requestaccepted

400 Invalid request

404 Associated resource notfound

406 Not acceptable

409 Conflicting resource

500 Internal server error

Try it out

GET v0internaldynamic_mappingactions Retrieve all the dynamic mapping actions defined in ESC

Try it out

POST v0internaldynamic_mappingactions Create new dynamic mapping action(s)

Implementation NotesDeletes all non-CORE dynamic mapping actions from ESC

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Delete all non-core actionsrequest accepted

Implementation NotesRetrieves all the dynamic mapping actions defined in ESC

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Get all actions requestaccepted

Implementation NotesCreates a dynamic mapping action(s)

Example request

POST v0internaldynamic_mappingactions HTTP11Content-Type applicationxmlAccept applicationxmlBodyltactions xmlns=urnietfparamsxmlnsnetconfbase10gt ltactiongt ltnamegtSomeActionNameltnamegt ltuserlabelgtUserFriendlyActionNameltuserlabelgt lttypegtscriptlttypegt ltversiongt1ltversiongt ltmetadatagt

Try it out

DELETE v0internaldynamic_mappingactionsaction_name Delete a dynamic mapping action from ESC

ltnamegtSomeActionNameltnamegt lttypegtscriptlttypegt ltversiongt1ltversiongt ltmetadatagt ltactiongtltactionsgt

In this example there is only one action but you can add more than one by adding additional tags within thetags

There are no callbacks for this API

Parameters

Parameter Value Description ParameterType Data Type

body (required)

Parameter content type

applicationxml

Actions payload body string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Create new action requestaccepted

400 Exception Message or Noaction definition found

409 Action [actionName] alreadyexists

Implementation NotesDeletes a dynamic mapping action from ESC

Parameters

Parameter Value Description ParameterType Data Type

Try it out

GET v0internaldynamic_mappingactionsaction_name Retrieve a dynamic mapping action by name

Try it out

action_name (required) Name of the actionyou want to delete

path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Delete action requestaccepted

400 Invalid action nameprovided Action[actionName] is a COREaction cannot delete orAction [actionName] iscurrently referenced in adeployment cannot delete

404 Action [actionName] notfound

Implementation NotesRetrieves a dynamic mapping action by name

Parameters

Parameter Value Description ParameterType Data Type

action_name (required) Name of the actionyou want to retrieve

path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Get action request accepted

400 Invalid action name provided[actionName]

404 Action [actionName] notfound

DELETE v0internaldynamic_mappingmetrics Delete all non-CORE dynamic mapping metrics from ESC

Try it out

GET v0internaldynamic_mappingmetrics Retrieve all the dynamic mapping metrics defined in ESC

Try it out

POST v0internaldynamic_mappingmetrics Create new dynamic mapping metric(s)

Implementation NotesDeletes all non-CORE dynamic mapping metrics from ESC

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Delete all non-core metricsrequest accepted

Implementation NotesRetrieves all the dynamic mapping metrics defined in ESC

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Get all metrics requestaccepted

Implementation NotesCreates a dynamic mapping metric(s)

Example request

POST v0internaldynamic_mappingmetrics HTTP11Content-Type applicationxmlAccept applicationxmlBodyltmetrics xmlns=urnietfparamsxmlnsnetconfbase10gt ltmetricgt ltnamegtSomeMetricNameltnamegt ltuserlabelgtUserFriendlyMetricNameltuserlabelgt lttypegtMONITOR_THRESHOLDlttypegt

Try it out

DELETE v0internaldynamic_mappingmetricsmetric_name Delete a dynamic mapping metric from ESC

ltversiongt1ltversiongt ltmetadatagt ltnamegtSomeMetricNameltnamegt lttypegtMONITOR_THRESHOLDlttypegt ltversiongt1ltversiongt ltmetadatagt ltmetricgtltmetricsgt

In this example there is only one metric but you can add more than one by adding additional tags within thetags

There are no callbacks for this API

Parameters

Parameter Value Description ParameterType Data Type

body (required)

Parameter content type

applicationxml

Metrics payload body string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Create new metric requestaccepted

400 Exception Message or Nometric definition found

409 Metric [metricName] alreadyexists

Implementation NotesDeletes a dynamic mapping metric from ESC

Parameters

Try it out

GET v0internaldynamic_mappingmetricsmetric_name Retrieve a dynamic mapping metric by name

Try it out

Parameter Value Description ParameterType Data Type

metric_name (required) Name of the metricyou want to delete

path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Delete metric requestaccepted

400 Invalid metric nameprovided Metric[metricName] is a COREmetric cannot delete orMetric [metricName] iscurrently referenced in adeployment cannot delete

404 Metric [metricName] notfound

Implementation NotesRetrieves a dynamic mapping metric by name

Parameters

Parameter Value Description ParameterType Data Type

metric_name (required) Name of the metricyou want to retrieve

path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Get metric request accepted

400 Invalid metric name provided[metricName]

404 Metric [metricName] notfound

Try it out

11-ESC Operation ModeGET v0operationmode Get operation mode in ESC

Model Model Schema

Try it out

POST v0operationmodeescOpMode Set operation mode in ESC

Model Model Schema

Try it out

Implementation NotesSet operation mode in ESC

Response Class (Status 200)

mode string

Response Content Type applicationxml

Implementation NotesSet operation mode in ESC

Response Class (Status 200)

mode string

Response Content Type applicationxml

Parameters

Parameter Value Description ParameterType Data Type

escOpMode [MAINTENACE ESC maintenacemode

path string

12-Host ActionsPOST v0hostshostNamedisable Disable a host

Try it out

POST v0hostshostNameenable Enable a host

Try it out

Implementation NotesTo disable a host

Parameters

Parameter Value Description ParameterType Data Type

Callback-ESC-Events

(required) Callback URL for hostaction notifications

header string

hostName (required) Target host name path string

Response MessagesHTTP StatusCode Reason Response Model Headers

default successful operation

Implementation NotesTo enable a host

Parameters

Parameter Value Description ParameterType Data Type

Callback-ESC-Events

(required) Callback URL for hostaction notifications

header string

hostName (required) Target host name path string

Response MessagesHTTP StatusCode Reason Response Model Headers

default successful operation

GET v0hostshostNamestatus Get the current status of the host

Try it out

13-ESC VIM Connectors Manage ESC VIM ConnectorsGET v0vims Get all VIM Connectors

Model Model Schema

Implementation NotesThis is to see if the host can be schedule to deploy instances

Response Class (Status 200)

Response Content Type applicationxml

Parameters

Parameter Value Description ParameterType Data Type

Client-Transaction-Id

header string

hostName (required) path string

Implementation NotesAll VIM Connectors in ESC will be returned as a List

Response Class (Status 200)

[ id string type OPENSTACK properties property [ name string value string ]

Try it out

POST v0vims Create a VIM connector in ESC

Model Model Schema

Try it out

event_type string ]

Response Content Type applicationxml

Implementation NotesCreate a VIM connector in ESC

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

body (required)

Parameter content type

applicationxml

VIM Connectorconfigurationpayload

body

id string type OPENSTACK properties property [ name string value string ] event_type string

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

500 Internal Server Error

DELETE v0vimsvim_id Delete a VIM Connector from ESC

Try it out

GET v0vimsvim_id Get a VIM Connector by its id

Try it out

Implementation NotesDelete a VIM Connector from ESC

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL for ESCnotifications

header string

vim_id (required) VIM ID path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 VIM Connector deletionrequest accepted

400 Invalid Request

404 VIM Id not found

500 Internal Server Error

Parameters

Parameter Value Description ParameterType Data Type

vim_id (required) VIM ID path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Get request accepted

404 VIM Id not found

PUT v0vimsvim_id Update an existing VIM connector in ESC

Model Model Schema

Try it out

14-ESC VIM Users Manage ESC VIM UsersGET v0vimsvim_idvim_users Get all VIM Users

Implementation NotesUpdate an existing VIM connector in ESC

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

vim_id (required) VIM ID path string

body (required)

Parameter content type

applicationxml

Update VIMConnectorconfigurationpayload

body

id string type OPENSTACK properties property [ name string value string ] event_type string

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

500 Internal Server Error

Try it out

POST v0vimsvim_idvim_users Create a VIM user under an existing VIM in ESC

Model Model Schema

Implementation NotesAll VIM Users in ESC will be returned as a List

Parameters

Parameter Value Description ParameterType Data Type

vim_id (required) path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Get request accepted

404 Unknown VIM Id provided

Implementation NotesCreate a VIM user in ESC

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

vim_id (required) Vim id path string

body (required)

Parameter content type

applicationxml

Vim userconfigurationpayload

body

credentials properties property [ name string value string ] id string vim_id string

Try it out

DELETE v0vimsvim_idvim_usersvim_user_id Delete a VIM User from ESC

Try it out

GET v0vimsvim_idvim_usersvim_user_id Get a VIM User by its id

event_type string

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

500 Internal Server Error

Implementation NotesDelete a VIM User from ESC

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL for ESCnotifications

header string

vim_id (required) Vim id path string

vim_user_id (required) Vim user id path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 VIM User Id not found

500 Internal Server Error

Try it out

PUT v0vimsvim_idvim_usersvim_user_id Update a VIM user under an existing VIM in ESC

Model Model Schema

Parameters

Parameter Value Description ParameterType Data Type

vim_id (required) Vim id path string

vim_user_id (required) Vim user id path string

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Get request accepted

404 VIM User Id not found

Implementation NotesUpdate a VIM user in ESC

Parameters

Parameter Value Description ParameterType Data Type

Callback (required) Callback URL forESC notifications

header string

vim_id (required) Vim id path string

vim_user_id (required) Vim user id path string

body (required)

Parameter content type

applicationxml

Vim userconfigurationpayload

body

credentials properties property [ name string value string ]

Try it out

Appendix-Callback Responses [Model Schemas]POST v0callbackssamplesdeployment Deployment Callback Response Payload Schema

Model Model Schema

id string vim_id string event_type string

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

500 Internal Server Error

Implementation NotesThis model schema displays details of ESCs response for Deployment Operations ESC sends payloadresponses at different stages of the deployment to the request header provided Callback URL

Parameters

Parameter Value Description ParameterType Data Type

ESC-Transaction-Id

header string

ESC-Status-Code

header string

ESC-Status-Message

header string

body

Parameter contenttype

applicationxml

body

dbDatamodel version string services service_definition [ deployment_name string name string

version string locators datacenter string switch_name string policies policy [ name string conditions condition [ name LCS_PRE_DEPLOY ] actions action [ name string type string stop_on_error false properties property [ name string value string ] ] ] networks network [ name string netid string shared false admin_state false router_external false provider_physical_network string provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [

name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string ] ] vm_group [ name string vm_instance [ vm_id string name string host_id string hostname string interfaces interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups string port_forwards port_forward [ port_forwarding_type port_number string ] ] volumes volume [ external_volume_id string internal_volume_id string

size string sizeunit string bus string type string outOfBand false bootIndex string image string ] ] shared_ip [ nic_id 0 shared_ip string ] ] datacenter string ] tenants tenant [ name string tenant_id string networks network [ name string netid string shared false admin_state false router_external false provider_physical_network string provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [ name string subnetid string cidr string gateway string no_gateway false dhcp false

ipversion string ] ] deployments [ deployment_name string service_name string service_version string deployment_id string service_id string vm_group [ name string vm_instance [ vm_id string name string host_id string hostname string interfaces interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups port_forwards port_forward [ port_forwarding_type port_number ] ] volumes volume [ external_volume_id internal_volume_id

size string sizeunit string bus string type string outOfBand false bootIndex string image string ] ] shared_ip [ nic_id 0 shared_ip string ] ] state_machine state SERVICE_UNDEF_STATE vm_state_machines vm_state_machine [ vm_name string state VM_UNDEF_STATE ] ] ] networks network [ name string netid string shared false admin_state false router_external false provider_physical_network string provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [

name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string ] ] images image [ name string image_id string public false image_name string state IMAGE_UNDEF_STATE ] flavors flavor [ name string flavor_id string public false flavor_name string state FLAVOR_UNDEF_STATE ] opdata status string stats hostname string os_name string os_release string arch string uptime 0 load loadone string loadfive string loadfifteen string cpu sockets 0 cores 0 threads 0

cpu_num 0 cpu_wio string cpu_speed 0 cpu_idle string cpu_user string cpu_system string cpu_aidle string memory mem_total string mem_free string memory_cached string mem_buffered string mem_shared string swap_total string swap_free string disk disks [ device string mount string disk_total 0 disk_used 0 ] netif interfaces [ interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups string port_forwards port_forward [ port_forwarding_type port_number string ] ]

] system_config active_vim string openstack_config os_auth_url string admin_role string os_tenant_name string os_username string member_role string vmware_config vcenter_ip string vcenter_port string vcenter_username string default_locators datacenter string networks network [ name string netid string shared false admin_state false router_external false provider_physical_network string provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [ name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string ] ]

images image [ name string image_id string public false image_name string state IMAGE_UNDEF_STATE ] flavors flavor [ name string flavor_id string public false flavor_name string state FLAVOR_UNDEF_STATE ] tenants tenant [ name string tenant_id string networks network [ name string netid string shared false admin_state false router_external false provider_physical_network provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [ name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string

] ] deployments [ deployment_name string service_name string service_version string deployment_id string service_id string vm_group [ name string vm_instance [ vm_id string name string host_id string hostname string interfaces interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups port_forwards port_forward port_forwarding_type port_number ] ] volumes volume [ external_volume_id internal_volume_id size string sizeunit string

bus string type string outOfBand false bootIndex string image string ] ] shared_ip [ nic_id 0 shared_ip string ] ] state_machine state SERVICE_UNDEF_STATE vm_state_machines vm_state_machine [ vm_name string state VM_UNDEF_STATE ] ] ] info product_name string esc_version major string minor string sprint string release string yang_model string timestamp string copyright company string homepage string dbDeployment deploymentId string

deploymentName string tenantId string serviceRegistrationId string eventTime string eventNotificationContentType 0 eventNotificationType 0 eventNotificationUrl string dataModel string classMetadata propertyNames [ string ] entityName string mutable false naturalIdentifierProperties [ 0 ] identifierType mutable false anyType false componentType false associationType false entityType false collectionType false name string identifierPropertyName string propertyTypes [ mutable false anyType false componentType false associationType false entityType false collectionType false name string ] versioned false propertyNullability [ true ] versionProperty 0 propertyLaziness [ true ] inherited false datacenter string cardinality 0 id string deployment_details [

sharedIps [ nic_id 0 shared_ip string ] vm_uuid string host_uuid string host_name string vm_name string vm_group_name string volume [ external_volume_id string internal_volume_id string size string sizeunit string bus string type string outOfBand false bootIndex string image string ] interface [ network_uuid string subnet_uuid string ip_address string mac_address string security_group [ string ] port_uuid string port_forward [ port_forwarding_type string port_number string ] type string model string nic_id 0 anycast_ip string shared_ip string netmask string gateway string ] vm_state_machine_state string ]

Try it out

POST v0callbackssamplesflavor Flavor Callback Response Payload Schema

internal_tenant_id string external_tenant_id string internal_deployment_id string external_deployment_id string deployment_stage string deployment_name string service_state_machine_state string locators datacenter string switch_name string

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

503 Failed to query VIM

Implementation NotesThis model schema displays details of ESCs response for Flavor Operations ESC sends a payload response tothe request header provided Callback URL

Parameters

Parameter Value Description ParameterType Data Type

ESC-Transaction-Id

header string

ESC-Status-Code

header string

name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string ] ] vm_group [ name string vm_instance [ vm_id string name string host_id string hostname string interfaces interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups string port_forwards port_forward [ port_forwarding_type port_number string ] ] volumes volume [ external_volume_id string internal_volume_id string

size string sizeunit string bus string type string outOfBand false bootIndex string image string ] ] shared_ip [ nic_id 0 shared_ip string ] ] datacenter string ] tenants tenant [ name string tenant_id string networks network [ name string netid string shared false admin_state false router_external false provider_physical_network string provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [ name string subnetid string cidr string gateway string no_gateway false dhcp false

ipversion string ] ] deployments [ deployment_name string service_name string service_version string deployment_id string service_id string vm_group [ name string vm_instance [ vm_id string name string host_id string hostname string interfaces interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups port_forwards port_forward [ port_forwarding_type port_number ] ] volumes volume [ external_volume_id internal_volume_id

size string sizeunit string bus string type string outOfBand false bootIndex string image string ] ] shared_ip [ nic_id 0 shared_ip string ] ] state_machine state SERVICE_UNDEF_STATE vm_state_machines vm_state_machine [ vm_name string state VM_UNDEF_STATE ] ] ] networks network [ name string netid string shared false admin_state false router_external false provider_physical_network string provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [

name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string ] ] images image [ name string image_id string public false image_name string state IMAGE_UNDEF_STATE ] flavors flavor [ name string flavor_id string public false flavor_name string state FLAVOR_UNDEF_STATE ] opdata status string stats hostname string os_name string os_release string arch string uptime 0 load loadone string loadfive string loadfifteen string cpu sockets 0 cores 0 threads 0

cpu_num 0 cpu_wio string cpu_speed 0 cpu_idle string cpu_user string cpu_system string cpu_aidle string memory mem_total string mem_free string memory_cached string mem_buffered string mem_shared string swap_total string swap_free string disk disks [ device string mount string disk_total 0 disk_used 0 ] netif interfaces [ interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups string port_forwards port_forward [ port_forwarding_type port_number string ] ]

] system_config active_vim string openstack_config os_auth_url string admin_role string os_tenant_name string os_username string member_role string vmware_config vcenter_ip string vcenter_port string vcenter_username string default_locators datacenter string networks network [ name string netid string shared false admin_state false router_external false provider_physical_network string provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [ name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string ] ]

images image [ name string image_id string public false image_name string state IMAGE_UNDEF_STATE ] flavors flavor [ name string flavor_id string public false flavor_name string state FLAVOR_UNDEF_STATE ] tenants tenant [ name string tenant_id string networks network [ name string netid string shared false admin_state false router_external false provider_physical_network provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [ name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string

] ] deployments [ deployment_name string service_name string service_version string deployment_id string service_id string vm_group [ name string vm_instance [ vm_id string name string host_id string hostname string interfaces interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups port_forwards port_forward port_forwarding_type port_number ] ] volumes volume [ external_volume_id internal_volume_id size string sizeunit string

bus string type string outOfBand false bootIndex string image string ] ] shared_ip [ nic_id 0 shared_ip string ] ] state_machine state SERVICE_UNDEF_STATE vm_state_machines vm_state_machine [ vm_name string state VM_UNDEF_STATE ] ] ] info product_name string esc_version major string minor string sprint string release string yang_model string timestamp string copyright company string homepage string dbDeployment deploymentId string

deploymentName string tenantId string serviceRegistrationId string eventTime string eventNotificationContentType 0 eventNotificationType 0 eventNotificationUrl string dataModel string classMetadata propertyNames [ string ] entityName string mutable false naturalIdentifierProperties [ 0 ] identifierType mutable false anyType false componentType false associationType false entityType false collectionType false name string identifierPropertyName string propertyTypes [ mutable false anyType false componentType false associationType false entityType false collectionType false name string ] versioned false propertyNullability [ true ] versionProperty 0 propertyLaziness [ true ] inherited false datacenter string cardinality 0 id string deployment_details [

sharedIps [ nic_id 0 shared_ip string ] vm_uuid string host_uuid string host_name string vm_name string vm_group_name string volume [ external_volume_id string internal_volume_id string size string sizeunit string bus string type string outOfBand false bootIndex string image string ] interface [ network_uuid string subnet_uuid string ip_address string mac_address string security_group [ string ] port_uuid string port_forward [ port_forwarding_type string port_number string ] type string model string nic_id 0 anycast_ip string shared_ip string netmask string gateway string ] vm_state_machine_state string ]

Try it out

POST v0callbackssamplesflavor Flavor Callback Response Payload Schema

internal_tenant_id string external_tenant_id string internal_deployment_id string external_deployment_id string deployment_stage string deployment_name string service_state_machine_state string locators datacenter string switch_name string

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

503 Failed to query VIM

Implementation NotesThis model schema displays details of ESCs response for Flavor Operations ESC sends a payload response tothe request header provided Callback URL

Parameters

Parameter Value Description ParameterType Data Type

ESC-Transaction-Id

header string

ESC-Status-Code

header string

size string sizeunit string bus string type string outOfBand false bootIndex string image string ] ] shared_ip [ nic_id 0 shared_ip string ] ] datacenter string ] tenants tenant [ name string tenant_id string networks network [ name string netid string shared false admin_state false router_external false provider_physical_network string provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [ name string subnetid string cidr string gateway string no_gateway false dhcp false

ipversion string ] ] deployments [ deployment_name string service_name string service_version string deployment_id string service_id string vm_group [ name string vm_instance [ vm_id string name string host_id string hostname string interfaces interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups port_forwards port_forward [ port_forwarding_type port_number ] ] volumes volume [ external_volume_id internal_volume_id

size string sizeunit string bus string type string outOfBand false bootIndex string image string ] ] shared_ip [ nic_id 0 shared_ip string ] ] state_machine state SERVICE_UNDEF_STATE vm_state_machines vm_state_machine [ vm_name string state VM_UNDEF_STATE ] ] ] networks network [ name string netid string shared false admin_state false router_external false provider_physical_network string provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [

name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string ] ] images image [ name string image_id string public false image_name string state IMAGE_UNDEF_STATE ] flavors flavor [ name string flavor_id string public false flavor_name string state FLAVOR_UNDEF_STATE ] opdata status string stats hostname string os_name string os_release string arch string uptime 0 load loadone string loadfive string loadfifteen string cpu sockets 0 cores 0 threads 0

cpu_num 0 cpu_wio string cpu_speed 0 cpu_idle string cpu_user string cpu_system string cpu_aidle string memory mem_total string mem_free string memory_cached string mem_buffered string mem_shared string swap_total string swap_free string disk disks [ device string mount string disk_total 0 disk_used 0 ] netif interfaces [ interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups string port_forwards port_forward [ port_forwarding_type port_number string ] ]

] system_config active_vim string openstack_config os_auth_url string admin_role string os_tenant_name string os_username string member_role string vmware_config vcenter_ip string vcenter_port string vcenter_username string default_locators datacenter string networks network [ name string netid string shared false admin_state false router_external false provider_physical_network string provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [ name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string ] ]

images image [ name string image_id string public false image_name string state IMAGE_UNDEF_STATE ] flavors flavor [ name string flavor_id string public false flavor_name string state FLAVOR_UNDEF_STATE ] tenants tenant [ name string tenant_id string networks network [ name string netid string shared false admin_state false router_external false provider_physical_network provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [ name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string

] ] deployments [ deployment_name string service_name string service_version string deployment_id string service_id string vm_group [ name string vm_instance [ vm_id string name string host_id string hostname string interfaces interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups port_forwards port_forward port_forwarding_type port_number ] ] volumes volume [ external_volume_id internal_volume_id size string sizeunit string

bus string type string outOfBand false bootIndex string image string ] ] shared_ip [ nic_id 0 shared_ip string ] ] state_machine state SERVICE_UNDEF_STATE vm_state_machines vm_state_machine [ vm_name string state VM_UNDEF_STATE ] ] ] info product_name string esc_version major string minor string sprint string release string yang_model string timestamp string copyright company string homepage string dbDeployment deploymentId string

deploymentName string tenantId string serviceRegistrationId string eventTime string eventNotificationContentType 0 eventNotificationType 0 eventNotificationUrl string dataModel string classMetadata propertyNames [ string ] entityName string mutable false naturalIdentifierProperties [ 0 ] identifierType mutable false anyType false componentType false associationType false entityType false collectionType false name string identifierPropertyName string propertyTypes [ mutable false anyType false componentType false associationType false entityType false collectionType false name string ] versioned false propertyNullability [ true ] versionProperty 0 propertyLaziness [ true ] inherited false datacenter string cardinality 0 id string deployment_details [

sharedIps [ nic_id 0 shared_ip string ] vm_uuid string host_uuid string host_name string vm_name string vm_group_name string volume [ external_volume_id string internal_volume_id string size string sizeunit string bus string type string outOfBand false bootIndex string image string ] interface [ network_uuid string subnet_uuid string ip_address string mac_address string security_group [ string ] port_uuid string port_forward [ port_forwarding_type string port_number string ] type string model string nic_id 0 anycast_ip string shared_ip string netmask string gateway string ] vm_state_machine_state string ]

Try it out

POST v0callbackssamplesflavor Flavor Callback Response Payload Schema

internal_tenant_id string external_tenant_id string internal_deployment_id string external_deployment_id string deployment_stage string deployment_name string service_state_machine_state string locators datacenter string switch_name string

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

503 Failed to query VIM

Implementation NotesThis model schema displays details of ESCs response for Flavor Operations ESC sends a payload response tothe request header provided Callback URL

Parameters

Parameter Value Description ParameterType Data Type

ESC-Transaction-Id

header string

ESC-Status-Code

header string

ipversion string ] ] deployments [ deployment_name string service_name string service_version string deployment_id string service_id string vm_group [ name string vm_instance [ vm_id string name string host_id string hostname string interfaces interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups port_forwards port_forward [ port_forwarding_type port_number ] ] volumes volume [ external_volume_id internal_volume_id

size string sizeunit string bus string type string outOfBand false bootIndex string image string ] ] shared_ip [ nic_id 0 shared_ip string ] ] state_machine state SERVICE_UNDEF_STATE vm_state_machines vm_state_machine [ vm_name string state VM_UNDEF_STATE ] ] ] networks network [ name string netid string shared false admin_state false router_external false provider_physical_network string provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [

name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string ] ] images image [ name string image_id string public false image_name string state IMAGE_UNDEF_STATE ] flavors flavor [ name string flavor_id string public false flavor_name string state FLAVOR_UNDEF_STATE ] opdata status string stats hostname string os_name string os_release string arch string uptime 0 load loadone string loadfive string loadfifteen string cpu sockets 0 cores 0 threads 0

cpu_num 0 cpu_wio string cpu_speed 0 cpu_idle string cpu_user string cpu_system string cpu_aidle string memory mem_total string mem_free string memory_cached string mem_buffered string mem_shared string swap_total string swap_free string disk disks [ device string mount string disk_total 0 disk_used 0 ] netif interfaces [ interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups string port_forwards port_forward [ port_forwarding_type port_number string ] ]

] system_config active_vim string openstack_config os_auth_url string admin_role string os_tenant_name string os_username string member_role string vmware_config vcenter_ip string vcenter_port string vcenter_username string default_locators datacenter string networks network [ name string netid string shared false admin_state false router_external false provider_physical_network string provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [ name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string ] ]

images image [ name string image_id string public false image_name string state IMAGE_UNDEF_STATE ] flavors flavor [ name string flavor_id string public false flavor_name string state FLAVOR_UNDEF_STATE ] tenants tenant [ name string tenant_id string networks network [ name string netid string shared false admin_state false router_external false provider_physical_network provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [ name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string

] ] deployments [ deployment_name string service_name string service_version string deployment_id string service_id string vm_group [ name string vm_instance [ vm_id string name string host_id string hostname string interfaces interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups port_forwards port_forward port_forwarding_type port_number ] ] volumes volume [ external_volume_id internal_volume_id size string sizeunit string

bus string type string outOfBand false bootIndex string image string ] ] shared_ip [ nic_id 0 shared_ip string ] ] state_machine state SERVICE_UNDEF_STATE vm_state_machines vm_state_machine [ vm_name string state VM_UNDEF_STATE ] ] ] info product_name string esc_version major string minor string sprint string release string yang_model string timestamp string copyright company string homepage string dbDeployment deploymentId string

deploymentName string tenantId string serviceRegistrationId string eventTime string eventNotificationContentType 0 eventNotificationType 0 eventNotificationUrl string dataModel string classMetadata propertyNames [ string ] entityName string mutable false naturalIdentifierProperties [ 0 ] identifierType mutable false anyType false componentType false associationType false entityType false collectionType false name string identifierPropertyName string propertyTypes [ mutable false anyType false componentType false associationType false entityType false collectionType false name string ] versioned false propertyNullability [ true ] versionProperty 0 propertyLaziness [ true ] inherited false datacenter string cardinality 0 id string deployment_details [

sharedIps [ nic_id 0 shared_ip string ] vm_uuid string host_uuid string host_name string vm_name string vm_group_name string volume [ external_volume_id string internal_volume_id string size string sizeunit string bus string type string outOfBand false bootIndex string image string ] interface [ network_uuid string subnet_uuid string ip_address string mac_address string security_group [ string ] port_uuid string port_forward [ port_forwarding_type string port_number string ] type string model string nic_id 0 anycast_ip string shared_ip string netmask string gateway string ] vm_state_machine_state string ]

Try it out

POST v0callbackssamplesflavor Flavor Callback Response Payload Schema

internal_tenant_id string external_tenant_id string internal_deployment_id string external_deployment_id string deployment_stage string deployment_name string service_state_machine_state string locators datacenter string switch_name string

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

503 Failed to query VIM

Implementation NotesThis model schema displays details of ESCs response for Flavor Operations ESC sends a payload response tothe request header provided Callback URL

Parameters

Parameter Value Description ParameterType Data Type

ESC-Transaction-Id

header string

ESC-Status-Code

header string

size string sizeunit string bus string type string outOfBand false bootIndex string image string ] ] shared_ip [ nic_id 0 shared_ip string ] ] state_machine state SERVICE_UNDEF_STATE vm_state_machines vm_state_machine [ vm_name string state VM_UNDEF_STATE ] ] ] networks network [ name string netid string shared false admin_state false router_external false provider_physical_network string provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [

name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string ] ] images image [ name string image_id string public false image_name string state IMAGE_UNDEF_STATE ] flavors flavor [ name string flavor_id string public false flavor_name string state FLAVOR_UNDEF_STATE ] opdata status string stats hostname string os_name string os_release string arch string uptime 0 load loadone string loadfive string loadfifteen string cpu sockets 0 cores 0 threads 0

cpu_num 0 cpu_wio string cpu_speed 0 cpu_idle string cpu_user string cpu_system string cpu_aidle string memory mem_total string mem_free string memory_cached string mem_buffered string mem_shared string swap_total string swap_free string disk disks [ device string mount string disk_total 0 disk_used 0 ] netif interfaces [ interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups string port_forwards port_forward [ port_forwarding_type port_number string ] ]

] system_config active_vim string openstack_config os_auth_url string admin_role string os_tenant_name string os_username string member_role string vmware_config vcenter_ip string vcenter_port string vcenter_username string default_locators datacenter string networks network [ name string netid string shared false admin_state false router_external false provider_physical_network string provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [ name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string ] ]

images image [ name string image_id string public false image_name string state IMAGE_UNDEF_STATE ] flavors flavor [ name string flavor_id string public false flavor_name string state FLAVOR_UNDEF_STATE ] tenants tenant [ name string tenant_id string networks network [ name string netid string shared false admin_state false router_external false provider_physical_network provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [ name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string

] ] deployments [ deployment_name string service_name string service_version string deployment_id string service_id string vm_group [ name string vm_instance [ vm_id string name string host_id string hostname string interfaces interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups port_forwards port_forward port_forwarding_type port_number ] ] volumes volume [ external_volume_id internal_volume_id size string sizeunit string

bus string type string outOfBand false bootIndex string image string ] ] shared_ip [ nic_id 0 shared_ip string ] ] state_machine state SERVICE_UNDEF_STATE vm_state_machines vm_state_machine [ vm_name string state VM_UNDEF_STATE ] ] ] info product_name string esc_version major string minor string sprint string release string yang_model string timestamp string copyright company string homepage string dbDeployment deploymentId string

deploymentName string tenantId string serviceRegistrationId string eventTime string eventNotificationContentType 0 eventNotificationType 0 eventNotificationUrl string dataModel string classMetadata propertyNames [ string ] entityName string mutable false naturalIdentifierProperties [ 0 ] identifierType mutable false anyType false componentType false associationType false entityType false collectionType false name string identifierPropertyName string propertyTypes [ mutable false anyType false componentType false associationType false entityType false collectionType false name string ] versioned false propertyNullability [ true ] versionProperty 0 propertyLaziness [ true ] inherited false datacenter string cardinality 0 id string deployment_details [

sharedIps [ nic_id 0 shared_ip string ] vm_uuid string host_uuid string host_name string vm_name string vm_group_name string volume [ external_volume_id string internal_volume_id string size string sizeunit string bus string type string outOfBand false bootIndex string image string ] interface [ network_uuid string subnet_uuid string ip_address string mac_address string security_group [ string ] port_uuid string port_forward [ port_forwarding_type string port_number string ] type string model string nic_id 0 anycast_ip string shared_ip string netmask string gateway string ] vm_state_machine_state string ]

Try it out

POST v0callbackssamplesflavor Flavor Callback Response Payload Schema

internal_tenant_id string external_tenant_id string internal_deployment_id string external_deployment_id string deployment_stage string deployment_name string service_state_machine_state string locators datacenter string switch_name string

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

503 Failed to query VIM

Implementation NotesThis model schema displays details of ESCs response for Flavor Operations ESC sends a payload response tothe request header provided Callback URL

Parameters

Parameter Value Description ParameterType Data Type

ESC-Transaction-Id

header string

ESC-Status-Code

header string

name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string ] ] images image [ name string image_id string public false image_name string state IMAGE_UNDEF_STATE ] flavors flavor [ name string flavor_id string public false flavor_name string state FLAVOR_UNDEF_STATE ] opdata status string stats hostname string os_name string os_release string arch string uptime 0 load loadone string loadfive string loadfifteen string cpu sockets 0 cores 0 threads 0

cpu_num 0 cpu_wio string cpu_speed 0 cpu_idle string cpu_user string cpu_system string cpu_aidle string memory mem_total string mem_free string memory_cached string mem_buffered string mem_shared string swap_total string swap_free string disk disks [ device string mount string disk_total 0 disk_used 0 ] netif interfaces [ interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups string port_forwards port_forward [ port_forwarding_type port_number string ] ]

] system_config active_vim string openstack_config os_auth_url string admin_role string os_tenant_name string os_username string member_role string vmware_config vcenter_ip string vcenter_port string vcenter_username string default_locators datacenter string networks network [ name string netid string shared false admin_state false router_external false provider_physical_network string provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [ name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string ] ]

images image [ name string image_id string public false image_name string state IMAGE_UNDEF_STATE ] flavors flavor [ name string flavor_id string public false flavor_name string state FLAVOR_UNDEF_STATE ] tenants tenant [ name string tenant_id string networks network [ name string netid string shared false admin_state false router_external false provider_physical_network provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [ name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string

] ] deployments [ deployment_name string service_name string service_version string deployment_id string service_id string vm_group [ name string vm_instance [ vm_id string name string host_id string hostname string interfaces interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups port_forwards port_forward port_forwarding_type port_number ] ] volumes volume [ external_volume_id internal_volume_id size string sizeunit string

bus string type string outOfBand false bootIndex string image string ] ] shared_ip [ nic_id 0 shared_ip string ] ] state_machine state SERVICE_UNDEF_STATE vm_state_machines vm_state_machine [ vm_name string state VM_UNDEF_STATE ] ] ] info product_name string esc_version major string minor string sprint string release string yang_model string timestamp string copyright company string homepage string dbDeployment deploymentId string

deploymentName string tenantId string serviceRegistrationId string eventTime string eventNotificationContentType 0 eventNotificationType 0 eventNotificationUrl string dataModel string classMetadata propertyNames [ string ] entityName string mutable false naturalIdentifierProperties [ 0 ] identifierType mutable false anyType false componentType false associationType false entityType false collectionType false name string identifierPropertyName string propertyTypes [ mutable false anyType false componentType false associationType false entityType false collectionType false name string ] versioned false propertyNullability [ true ] versionProperty 0 propertyLaziness [ true ] inherited false datacenter string cardinality 0 id string deployment_details [

sharedIps [ nic_id 0 shared_ip string ] vm_uuid string host_uuid string host_name string vm_name string vm_group_name string volume [ external_volume_id string internal_volume_id string size string sizeunit string bus string type string outOfBand false bootIndex string image string ] interface [ network_uuid string subnet_uuid string ip_address string mac_address string security_group [ string ] port_uuid string port_forward [ port_forwarding_type string port_number string ] type string model string nic_id 0 anycast_ip string shared_ip string netmask string gateway string ] vm_state_machine_state string ]

Try it out

POST v0callbackssamplesflavor Flavor Callback Response Payload Schema

internal_tenant_id string external_tenant_id string internal_deployment_id string external_deployment_id string deployment_stage string deployment_name string service_state_machine_state string locators datacenter string switch_name string

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

503 Failed to query VIM

Implementation NotesThis model schema displays details of ESCs response for Flavor Operations ESC sends a payload response tothe request header provided Callback URL

Parameters

Parameter Value Description ParameterType Data Type

ESC-Transaction-Id

header string

ESC-Status-Code

header string

cpu_num 0 cpu_wio string cpu_speed 0 cpu_idle string cpu_user string cpu_system string cpu_aidle string memory mem_total string mem_free string memory_cached string mem_buffered string mem_shared string swap_total string swap_free string disk disks [ device string mount string disk_total 0 disk_used 0 ] netif interfaces [ interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups string port_forwards port_forward [ port_forwarding_type port_number string ] ]

] system_config active_vim string openstack_config os_auth_url string admin_role string os_tenant_name string os_username string member_role string vmware_config vcenter_ip string vcenter_port string vcenter_username string default_locators datacenter string networks network [ name string netid string shared false admin_state false router_external false provider_physical_network string provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [ name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string ] ]

images image [ name string image_id string public false image_name string state IMAGE_UNDEF_STATE ] flavors flavor [ name string flavor_id string public false flavor_name string state FLAVOR_UNDEF_STATE ] tenants tenant [ name string tenant_id string networks network [ name string netid string shared false admin_state false router_external false provider_physical_network provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [ name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string

] ] deployments [ deployment_name string service_name string service_version string deployment_id string service_id string vm_group [ name string vm_instance [ vm_id string name string host_id string hostname string interfaces interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups port_forwards port_forward port_forwarding_type port_number ] ] volumes volume [ external_volume_id internal_volume_id size string sizeunit string

bus string type string outOfBand false bootIndex string image string ] ] shared_ip [ nic_id 0 shared_ip string ] ] state_machine state SERVICE_UNDEF_STATE vm_state_machines vm_state_machine [ vm_name string state VM_UNDEF_STATE ] ] ] info product_name string esc_version major string minor string sprint string release string yang_model string timestamp string copyright company string homepage string dbDeployment deploymentId string

deploymentName string tenantId string serviceRegistrationId string eventTime string eventNotificationContentType 0 eventNotificationType 0 eventNotificationUrl string dataModel string classMetadata propertyNames [ string ] entityName string mutable false naturalIdentifierProperties [ 0 ] identifierType mutable false anyType false componentType false associationType false entityType false collectionType false name string identifierPropertyName string propertyTypes [ mutable false anyType false componentType false associationType false entityType false collectionType false name string ] versioned false propertyNullability [ true ] versionProperty 0 propertyLaziness [ true ] inherited false datacenter string cardinality 0 id string deployment_details [

sharedIps [ nic_id 0 shared_ip string ] vm_uuid string host_uuid string host_name string vm_name string vm_group_name string volume [ external_volume_id string internal_volume_id string size string sizeunit string bus string type string outOfBand false bootIndex string image string ] interface [ network_uuid string subnet_uuid string ip_address string mac_address string security_group [ string ] port_uuid string port_forward [ port_forwarding_type string port_number string ] type string model string nic_id 0 anycast_ip string shared_ip string netmask string gateway string ] vm_state_machine_state string ]

Try it out

POST v0callbackssamplesflavor Flavor Callback Response Payload Schema

internal_tenant_id string external_tenant_id string internal_deployment_id string external_deployment_id string deployment_stage string deployment_name string service_state_machine_state string locators datacenter string switch_name string

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

503 Failed to query VIM

Implementation NotesThis model schema displays details of ESCs response for Flavor Operations ESC sends a payload response tothe request header provided Callback URL

Parameters

Parameter Value Description ParameterType Data Type

ESC-Transaction-Id

header string

ESC-Status-Code

header string

] system_config active_vim string openstack_config os_auth_url string admin_role string os_tenant_name string os_username string member_role string vmware_config vcenter_ip string vcenter_port string vcenter_username string default_locators datacenter string networks network [ name string netid string shared false admin_state false router_external false provider_physical_network string provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [ name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string ] ]

images image [ name string image_id string public false image_name string state IMAGE_UNDEF_STATE ] flavors flavor [ name string flavor_id string public false flavor_name string state FLAVOR_UNDEF_STATE ] tenants tenant [ name string tenant_id string networks network [ name string netid string shared false admin_state false router_external false provider_physical_network provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [ name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string

] ] deployments [ deployment_name string service_name string service_version string deployment_id string service_id string vm_group [ name string vm_instance [ vm_id string name string host_id string hostname string interfaces interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups port_forwards port_forward port_forwarding_type port_number ] ] volumes volume [ external_volume_id internal_volume_id size string sizeunit string

bus string type string outOfBand false bootIndex string image string ] ] shared_ip [ nic_id 0 shared_ip string ] ] state_machine state SERVICE_UNDEF_STATE vm_state_machines vm_state_machine [ vm_name string state VM_UNDEF_STATE ] ] ] info product_name string esc_version major string minor string sprint string release string yang_model string timestamp string copyright company string homepage string dbDeployment deploymentId string

deploymentName string tenantId string serviceRegistrationId string eventTime string eventNotificationContentType 0 eventNotificationType 0 eventNotificationUrl string dataModel string classMetadata propertyNames [ string ] entityName string mutable false naturalIdentifierProperties [ 0 ] identifierType mutable false anyType false componentType false associationType false entityType false collectionType false name string identifierPropertyName string propertyTypes [ mutable false anyType false componentType false associationType false entityType false collectionType false name string ] versioned false propertyNullability [ true ] versionProperty 0 propertyLaziness [ true ] inherited false datacenter string cardinality 0 id string deployment_details [

sharedIps [ nic_id 0 shared_ip string ] vm_uuid string host_uuid string host_name string vm_name string vm_group_name string volume [ external_volume_id string internal_volume_id string size string sizeunit string bus string type string outOfBand false bootIndex string image string ] interface [ network_uuid string subnet_uuid string ip_address string mac_address string security_group [ string ] port_uuid string port_forward [ port_forwarding_type string port_number string ] type string model string nic_id 0 anycast_ip string shared_ip string netmask string gateway string ] vm_state_machine_state string ]

Try it out

POST v0callbackssamplesflavor Flavor Callback Response Payload Schema

internal_tenant_id string external_tenant_id string internal_deployment_id string external_deployment_id string deployment_stage string deployment_name string service_state_machine_state string locators datacenter string switch_name string

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

503 Failed to query VIM

Implementation NotesThis model schema displays details of ESCs response for Flavor Operations ESC sends a payload response tothe request header provided Callback URL

Parameters

Parameter Value Description ParameterType Data Type

ESC-Transaction-Id

header string

ESC-Status-Code

header string

images image [ name string image_id string public false image_name string state IMAGE_UNDEF_STATE ] flavors flavor [ name string flavor_id string public false flavor_name string state FLAVOR_UNDEF_STATE ] tenants tenant [ name string tenant_id string networks network [ name string netid string shared false admin_state false router_external false provider_physical_network provider_network_type string provider_segmentation_id 0 switch_name string vlan_id 0 number_of_ports 0 status string subnets subnet [ name string subnetid string cidr string gateway string no_gateway false dhcp false ipversion string

] ] deployments [ deployment_name string service_name string service_version string deployment_id string service_id string vm_group [ name string vm_instance [ vm_id string name string host_id string hostname string interfaces interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups port_forwards port_forward port_forwarding_type port_number ] ] volumes volume [ external_volume_id internal_volume_id size string sizeunit string

bus string type string outOfBand false bootIndex string image string ] ] shared_ip [ nic_id 0 shared_ip string ] ] state_machine state SERVICE_UNDEF_STATE vm_state_machines vm_state_machine [ vm_name string state VM_UNDEF_STATE ] ] ] info product_name string esc_version major string minor string sprint string release string yang_model string timestamp string copyright company string homepage string dbDeployment deploymentId string

deploymentName string tenantId string serviceRegistrationId string eventTime string eventNotificationContentType 0 eventNotificationType 0 eventNotificationUrl string dataModel string classMetadata propertyNames [ string ] entityName string mutable false naturalIdentifierProperties [ 0 ] identifierType mutable false anyType false componentType false associationType false entityType false collectionType false name string identifierPropertyName string propertyTypes [ mutable false anyType false componentType false associationType false entityType false collectionType false name string ] versioned false propertyNullability [ true ] versionProperty 0 propertyLaziness [ true ] inherited false datacenter string cardinality 0 id string deployment_details [

sharedIps [ nic_id 0 shared_ip string ] vm_uuid string host_uuid string host_name string vm_name string vm_group_name string volume [ external_volume_id string internal_volume_id string size string sizeunit string bus string type string outOfBand false bootIndex string image string ] interface [ network_uuid string subnet_uuid string ip_address string mac_address string security_group [ string ] port_uuid string port_forward [ port_forwarding_type string port_number string ] type string model string nic_id 0 anycast_ip string shared_ip string netmask string gateway string ] vm_state_machine_state string ]

Try it out

POST v0callbackssamplesflavor Flavor Callback Response Payload Schema

internal_tenant_id string external_tenant_id string internal_deployment_id string external_deployment_id string deployment_stage string deployment_name string service_state_machine_state string locators datacenter string switch_name string

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

503 Failed to query VIM

Implementation NotesThis model schema displays details of ESCs response for Flavor Operations ESC sends a payload response tothe request header provided Callback URL

Parameters

Parameter Value Description ParameterType Data Type

ESC-Transaction-Id

header string

ESC-Status-Code

header string

] ] deployments [ deployment_name string service_name string service_version string deployment_id string service_id string vm_group [ name string vm_instance [ vm_id string name string host_id string hostname string interfaces interface [ nicid 0 model E_1000 type string port_id string network string subnet string ip_address string mac_address string netmask string gateway string security_groups port_forwards port_forward port_forwarding_type port_number ] ] volumes volume [ external_volume_id internal_volume_id size string sizeunit string

bus string type string outOfBand false bootIndex string image string ] ] shared_ip [ nic_id 0 shared_ip string ] ] state_machine state SERVICE_UNDEF_STATE vm_state_machines vm_state_machine [ vm_name string state VM_UNDEF_STATE ] ] ] info product_name string esc_version major string minor string sprint string release string yang_model string timestamp string copyright company string homepage string dbDeployment deploymentId string

deploymentName string tenantId string serviceRegistrationId string eventTime string eventNotificationContentType 0 eventNotificationType 0 eventNotificationUrl string dataModel string classMetadata propertyNames [ string ] entityName string mutable false naturalIdentifierProperties [ 0 ] identifierType mutable false anyType false componentType false associationType false entityType false collectionType false name string identifierPropertyName string propertyTypes [ mutable false anyType false componentType false associationType false entityType false collectionType false name string ] versioned false propertyNullability [ true ] versionProperty 0 propertyLaziness [ true ] inherited false datacenter string cardinality 0 id string deployment_details [

sharedIps [ nic_id 0 shared_ip string ] vm_uuid string host_uuid string host_name string vm_name string vm_group_name string volume [ external_volume_id string internal_volume_id string size string sizeunit string bus string type string outOfBand false bootIndex string image string ] interface [ network_uuid string subnet_uuid string ip_address string mac_address string security_group [ string ] port_uuid string port_forward [ port_forwarding_type string port_number string ] type string model string nic_id 0 anycast_ip string shared_ip string netmask string gateway string ] vm_state_machine_state string ]

Try it out

POST v0callbackssamplesflavor Flavor Callback Response Payload Schema

internal_tenant_id string external_tenant_id string internal_deployment_id string external_deployment_id string deployment_stage string deployment_name string service_state_machine_state string locators datacenter string switch_name string

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

503 Failed to query VIM

Implementation NotesThis model schema displays details of ESCs response for Flavor Operations ESC sends a payload response tothe request header provided Callback URL

Parameters

Parameter Value Description ParameterType Data Type

ESC-Transaction-Id

header string

ESC-Status-Code

header string

bus string type string outOfBand false bootIndex string image string ] ] shared_ip [ nic_id 0 shared_ip string ] ] state_machine state SERVICE_UNDEF_STATE vm_state_machines vm_state_machine [ vm_name string state VM_UNDEF_STATE ] ] ] info product_name string esc_version major string minor string sprint string release string yang_model string timestamp string copyright company string homepage string dbDeployment deploymentId string

deploymentName string tenantId string serviceRegistrationId string eventTime string eventNotificationContentType 0 eventNotificationType 0 eventNotificationUrl string dataModel string classMetadata propertyNames [ string ] entityName string mutable false naturalIdentifierProperties [ 0 ] identifierType mutable false anyType false componentType false associationType false entityType false collectionType false name string identifierPropertyName string propertyTypes [ mutable false anyType false componentType false associationType false entityType false collectionType false name string ] versioned false propertyNullability [ true ] versionProperty 0 propertyLaziness [ true ] inherited false datacenter string cardinality 0 id string deployment_details [

sharedIps [ nic_id 0 shared_ip string ] vm_uuid string host_uuid string host_name string vm_name string vm_group_name string volume [ external_volume_id string internal_volume_id string size string sizeunit string bus string type string outOfBand false bootIndex string image string ] interface [ network_uuid string subnet_uuid string ip_address string mac_address string security_group [ string ] port_uuid string port_forward [ port_forwarding_type string port_number string ] type string model string nic_id 0 anycast_ip string shared_ip string netmask string gateway string ] vm_state_machine_state string ]

Try it out

POST v0callbackssamplesflavor Flavor Callback Response Payload Schema

internal_tenant_id string external_tenant_id string internal_deployment_id string external_deployment_id string deployment_stage string deployment_name string service_state_machine_state string locators datacenter string switch_name string

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

503 Failed to query VIM

Implementation NotesThis model schema displays details of ESCs response for Flavor Operations ESC sends a payload response tothe request header provided Callback URL

Parameters

Parameter Value Description ParameterType Data Type

ESC-Transaction-Id

header string

ESC-Status-Code

header string

deploymentName string tenantId string serviceRegistrationId string eventTime string eventNotificationContentType 0 eventNotificationType 0 eventNotificationUrl string dataModel string classMetadata propertyNames [ string ] entityName string mutable false naturalIdentifierProperties [ 0 ] identifierType mutable false anyType false componentType false associationType false entityType false collectionType false name string identifierPropertyName string propertyTypes [ mutable false anyType false componentType false associationType false entityType false collectionType false name string ] versioned false propertyNullability [ true ] versionProperty 0 propertyLaziness [ true ] inherited false datacenter string cardinality 0 id string deployment_details [

sharedIps [ nic_id 0 shared_ip string ] vm_uuid string host_uuid string host_name string vm_name string vm_group_name string volume [ external_volume_id string internal_volume_id string size string sizeunit string bus string type string outOfBand false bootIndex string image string ] interface [ network_uuid string subnet_uuid string ip_address string mac_address string security_group [ string ] port_uuid string port_forward [ port_forwarding_type string port_number string ] type string model string nic_id 0 anycast_ip string shared_ip string netmask string gateway string ] vm_state_machine_state string ]

Try it out

POST v0callbackssamplesflavor Flavor Callback Response Payload Schema

internal_tenant_id string external_tenant_id string internal_deployment_id string external_deployment_id string deployment_stage string deployment_name string service_state_machine_state string locators datacenter string switch_name string

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

503 Failed to query VIM

Implementation NotesThis model schema displays details of ESCs response for Flavor Operations ESC sends a payload response tothe request header provided Callback URL

Parameters

Parameter Value Description ParameterType Data Type

ESC-Transaction-Id

header string

ESC-Status-Code

header string

sharedIps [ nic_id 0 shared_ip string ] vm_uuid string host_uuid string host_name string vm_name string vm_group_name string volume [ external_volume_id string internal_volume_id string size string sizeunit string bus string type string outOfBand false bootIndex string image string ] interface [ network_uuid string subnet_uuid string ip_address string mac_address string security_group [ string ] port_uuid string port_forward [ port_forwarding_type string port_number string ] type string model string nic_id 0 anycast_ip string shared_ip string netmask string gateway string ] vm_state_machine_state string ]

Try it out

POST v0callbackssamplesflavor Flavor Callback Response Payload Schema

internal_tenant_id string external_tenant_id string internal_deployment_id string external_deployment_id string deployment_stage string deployment_name string service_state_machine_state string locators datacenter string switch_name string

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

503 Failed to query VIM

Implementation NotesThis model schema displays details of ESCs response for Flavor Operations ESC sends a payload response tothe request header provided Callback URL

Parameters

Parameter Value Description ParameterType Data Type

ESC-Transaction-Id

header string

ESC-Status-Code

header string

Try it out

POST v0callbackssamplesflavor Flavor Callback Response Payload Schema

internal_tenant_id string external_tenant_id string internal_deployment_id string external_deployment_id string deployment_stage string deployment_name string service_state_machine_state string locators datacenter string switch_name string

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 An associated resource notfound

406 Not Acceptable

409 Conflicting Request

500 Internal server error

503 Failed to query VIM

Implementation NotesThis model schema displays details of ESCs response for Flavor Operations ESC sends a payload response tothe request header provided Callback URL

Parameters

Parameter Value Description ParameterType Data Type

ESC-Transaction-Id

header string

ESC-Status-Code

header string

Model Model Schema

Try it out

POST v0callbackssamplesimage Image Callback Response Payload Schema

ESC-Status-Message

header string

body

Parameter contenttype

applicationxml

body

properties internal_flavor_id string external_flavor_id string name string vcpus 0 memory_mb 0 root_disk_mb 0 ephemeral_disk_mb 0 swap_disk_mb 0 service_registration_id string event_type CREATE_FLAVOR

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 Flavor Id not found

406 Operation not supported onVIMFlavor part of serviceregistration

409 Conflicting Request

500 Internal server error

Implementation NotesThis model schema displays details of ESCs response for Image Operations ESC sends a payload response tothe request header provided Callback URL

Parameters

Parameter Value Description ParameterType Data Type

Model Model Schema

Try it out

POST v0callbackssamplesnetwork Network Callback Response Payload Schema

ESC-Transaction-Id

header string

ESC-Status-Code

header string

ESC-Status-Message

header string

body

Parameter content type

applicationxml

body

imageIsEnabled false imageCheckSum string serviceRegistrationId string internal_image_id string internal_tenant_id string external_image_id string name string src string disk_format string container_format string e1000_net false virtio_net false disk_bus string size 0 sizeunit string visibility private locators datacenter string switch_name string event_type CREATE_IMAGE

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 Image Id not found

409 Conflicting Request

Model Model Schema

Implementation NotesThis model schema displays details of ESCs response for Network Operations ESC sends a payload responseto the request header provided Callback URL

Parameters

Parameter Value Description ParameterType Data Type

ESC-Transaction-Id

header string

ESC-Status-Code

header string

ESC-Status-Message

header string

body

Parameter contenttype

applicationxml

body

internalDeploymentId string internal_tenant_id string internal_network_id string name string shared false external_tenant_id string external_network_id string subnet [ string ] admin_state_up false locators datacenter string switch_name string event_type CREATE_NETWORK number_of_ports 0 provider_segmentation_id string router_external false provider_physical_network string provider_network_type string vlan_id 0 switch_name string

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

Try it out

POST v0callbackssamplessubnet Subnet Callback Response Payload Schema

Model Model Schema

400 Invalid Request

404 Network Id not found

409 Conflicting Request

500 Internal server error

503 Unable to query VIM

Implementation NotesThis model schema displays details of ESCs response for Subnet Operations ESC sends a payload responseto the request header provided Callback URL

Parameters

Parameter Value Description ParameterType Data Type

ESC-Transaction-Id

header string

ESC-Status-Code

header string

ESC-Status-Message

header string

body

Parameter content type

applicationxml

body

internal_tenant_id string external_tenant_id string internal_network_id string external_network_id string internal_subnet_id string external_subnet_id string name string allocation_pools [ start string end string ] gateway_ip string ip_version 0 cidr string

Try it out

POST v0callbackssamplestenant Tenant Callback Response Payload Schema

Model Model Schema

enable_dhcp false event_type CREATE_SUBNET

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

404 Subnet Id not found

409 Conflicting Request

500 Internal server error

Implementation NotesThis model schema displays details of ESCs response for Tenant Operations ESC sends a payload response tothe request header provided Callback URL

Parameters

Parameter Value Description ParameterType Data Type

ESC-Transaction-Id

header string

ESC-Status-Code

header string

ESC-Status-Message

header string

body

Parameter content type

applicationxml

body

internal_tenant_id string external_tenant_id string name string enabled false event_type CREATE_TENANT managed_resource false

Try it out

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

200 Request accepted

400 Invalid Request

409 Conflicting Request

[ BASE URL ESCManager API VERSION 100 ]