ExtAPI Service Instantiation

RequestDetails {

requestDetails

M

Container

ModelInfo {}

modelInfo

M

Container

Refer to section 2 above

CloudConfiguration {}

cloudConfiguration

O

Container

Refer to section 1 above

SubscriberInfo {

subscriberInfo

M

Container

  GlobalSubscriberId

globalSubscriberId

M

String

Global customer Id (in A&AI)

  SubscriberName

subscriberName

O

string

Subscriber Name.  MSO is not creating customers so not required.

}

End of SubscriberInfo

RequestInfo {}

requestInfo

M

Container

Refer to section 4 above

RequestParameters{}

requestParameters

M

Container

Refer to section 5 above

}

End of RequestDetails

modelInfo

FIELD NAME

TAG NAME

M

O

C

FORMAT

VALUES

(E=enumerated value;

D=default value)

NOTES

ModelInfo {

modelInfo

M

Container

  ModelType

modelType

M

string

E={“service” | “vnf” | “vfModule” | “volumeGroup” | “network” }

Matches the type of “instance” that is being requested to be orchestrated.

  ModelInvariantId

modelInvariantId

C

string

Always REQUIRED, except for 1) DELETE of any resource

Note: VID should still provide this field on a DELETE if populated in A&AI (persona-model-id).

2) VF Module CREATE in the relatedInstance.modelInfo[volumeGroup] object (if attaching a volumeGroup to a VF Module)

3) Network CREATE/UPDATE.

Invariant UUID for the model name, irrespective of the version, as defined by ASDC

      ModelNameVersionId

modelNameVersionId

O

string

UUID for the model name and version combination, as defined in ASDC

  ModelName

modelName

C

string

Always REQUIRED, except for

1) DELETE of a resource that does NOT have a  SDN-C preload (service, vnf, volumeGroup).

2) VF Module CREATE in the relatedInstance.modelInfo[volumeGroup] object (if attaching a volumeGroup to a VF Module).

Name of the model entity as defined in ASDC (non-authoritative)

  ModelVersion

modelVersion

C

string

Always REQUIRED, except for 1) DELETE of any resource

Note: VID should still provide this field on a DELETE if populated in A&AI (persona-model-version).

2) VF Module CREATE in the relatedInstance.modelInfo[volumeGroup] object (if attaching a volumeGroup to a VF Module)

3) Network CREATE/UPDATE.

Version number of the model entity as defined in ASDC (non-authoritative)

   ModelCustomizationName

modelCustomizationName

C

String

Required when modelType = vnf, except for VNF DELETEs.

Reference to the customized set of parameters associated with a model in a given service context.

In the current release this means a VF resource within a service model in ASDC that has had its VF Module(s) ENV file values customized.

}

End ModelInfo

cloudConfiguration

FIELD NAME

TAG NAME

M

O

C

FORMAT

VALUES

(E=enumerated value;

D=default value)

NOTES

CloudConfiguration {

cloudConfiguration

C

Container

  LcpCloudRegionId

  lcpCloudRegionId

M

string

AIC LCP node location identifier

  TenantId

  tenantId

M

string

Openstack tenant id (UUID)

}

End CloudConfiguration

requestInfo

FIELD NAME

TAG NAME

M

O

C

FORMAT

VALUES

(E=enumerated value;

D=default value)

NOTES

RequestInfo{

requestInfo

M

Container

  InstanceName

instanceName

C

String

VID user provided name** for the instance being operated on (note: must be unique within A&AI for the given entity type).

**

the InstanceName provided (for all resources) must contain only alphanumeric or "_-." characters, and must start with alpha.  Spaces are not allowed (VID user should replace any spaces with underscore).

NOTE: For resources that currently end up being orchestrated into AIC (volumeGroup, vfModule, network), this field becomes the heat stack name.

  ProductFamilyId

productFamilyId

C

String

UUID for the product family associated with the model being operated on (named service-id in A&AI) 

  Source

source

M

String

Source of the request (non-authoritative).  The authoritative source is revealed through authentication.

VID MUST use a value of “VID” (else recipe lookup will fail).

  SuppressRollback

suppressRollback

O

Boolean

D={“false”}

Is not supported for UPDATE/DELETE.

Automatically revert/rollback changes that have been made when instantiation fails. 

}

End of RequestInfo

requestParameters

FIELD NAME

TAG NAME

M

O

C

FORMAT

VALUES

(E=enumerated value;

D=default value)

NOTES

RequestParameters{

requestParameters

C

Container

SubscriptionServiceType

subscriptionServiceType

C

String

In A&AI’s service-instance object hierarchy, becomes the service-type parameter

  UserParams[

userParams

O

array

Optional tag/value pairs for extra params not included in requestDetails

      name

name

O

String

Tag name of attribute

      value

value

O

String

Value of the tag

]

End of UserParams

}

End of RequestParameters