1 vCPE Homing Use Case
- 1.1 vCPE Service Model
- 1.2 Homing Policies and information sources relevant to the policies
- 1.3 Homing Workflow
- 1.4 SO - HAS API (R) - before retrieving homing policies
  - 1.4.1 SO - HAS API (R)
  - 1.4.2 vCPE Homing Template (JSON)
  - 1.4.3 vCPE Homing Template (YAML)
- 1.5 HAS Homing Response
  - 1.5.1 State - Done
    - 1.5.1.1 vCPE homing response (JSON)
  - 1.5.2 State - Error
    - 1.5.2.1 HAS Error Response
  - 1.5.3 State - Template
    - 1.5.3.1 HAS Plan in Template State
  - 1.5.4 State - Solving
    - 1.5.4.1 HAS Plan in Solving state

vCPE Homing Use Case

This document describes the Homing Template Specifications for residential vCPE. It is a work in progress and subject to frequent revision.

vCPE Service Model

Homing Policies and information sources relevant to the policies

Homing Workflow

SO - HAS API (R) - before retrieving homing policies

SO - HAS API (R)

requestInfo:
  callbackUrl: https://so:5000/callback
  numSolutions: 1
  optimizer:
  - placement
  requestId: yyy-yyy-yyyy
  sourceId: so
  timeout: 600
  transactionId: xxx-xxx-xxxx
  requestType: new
placementInfo:
  orderInfo:
    requestParameters:
      customerLatitude: 32.897480
      customerLongitude: -97.040443
      customerName: some_company
  demandInfo:
    placementDemands:
    - resourceName: vGMuxInfra
      resourceId: some_resource_id
      tenantId: some_tenant_id
      resourceModelInfo:
        modelId: vGMux_model_id
        modelName: ''
        modelType: allotted
        modelVersion: '2.0'
      existingPlacement:
        serviceInstanceId: 87257b49-9602-4ca1-9817-094e52bc873b
      excludedCandidates:
      - candidateType: service
        candidates:
        - serviceInstanceId: 1ac71fb8-ad43-4e16-9459-c3f372b8236d
      requiredCandidates:
      - candidateType: service