{"type":"api","title":"Add Cw VM","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/e7cf6406-31b8-3f42-91c0-19f86a4708d2","info":{"title":"Crosswork VM Node Install APIs","description":"Crosswork VM Node Install APIs allow users to add and delete nodes.","version":"3.0.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/VM_INSTALL/vm-install-overview.md"}},"swagger":"2.0","basePath":"/crosswork/platform/v1","schemes":["http","https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Bearer token for API authentication."}}},"spec":{"description":"Add Cw VM in Crosswork. Returned OpResult Id identifies the assigned VM id","summary":"Add Cw VM","operationId":"CwVmMangager_AddCwVM","responses":{"200":{"description":"A successful response.","schema":{"type":"object","properties":{"Result":{"description":"ResultValue indicates the success/failure for the requested operation.","type":"string","enum":["NOOP","SUCCESS","FAILURE"],"default":"NOOP","example":"SUCCESS","$$ref":"#/definitions/install_apiResultValue"},"Description":{"type":"string","title":"Addional response information"},"ResultMap":{"type":"object","additionalProperties":{"type":"string"},"title":"Supplementary keyed response info for the operation (for example: version number, error message)"},"ResultString":{"type":"array","items":{"type":"string"},"title":"Simple result string"},"Id":{"type":"string","title":"Resource Identifier returned by operation, if any"}},"description":"OpResult is used to indicate whether an operation has been accepted or not. A string or map payload provides the additional response information (for example: version number, error data).","example":{"Result":"SUCCESS","Description":"Operation completed successfully.","ResultMap":{"version":"1.0","message":"No errors"},"ResultString":["Operation successful"],"Id":"resource-123"},"$$ref":"#/definitions/install_apiOpResult"}},"default":{"description":"An unexpected error response.","schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"type_url":{"type":"string"},"value":{"type":"string","format":"byte"}},"example":{"type_url":"type.googleapis.com/google.protobuf.Any","value":"Error details in binary format"},"$$ref":"#/definitions/protobufAny"}}},"example":{"error":"RuntimeException","code":500,"message":"An unexpected error occurred during execution.","details":[{"type_url":"type.googleapis.com/google.protobuf.Any","value":"Error details in binary format"}]},"$$ref":"#/definitions/runtimeError"}}},"parameters":[{"name":"body","in":"body","required":true,"description":"Payload containing VM configuration details for Crosswork installation.","schema":{"type":"object","properties":{"ManagementIPAddress":{"type":"string","title":"The VM's management IP address"},"ManagementIPv4Address":{"type":"string","title":"The VM's management IPv4 address"},"ManagementIPv6Address":{"type":"string","title":"The VM's management IPv6 address"},"DataIPAddress":{"type":"string","title":"The VM's data IP address"},"DataIPv4Address":{"type":"string","title":"The VM's data IPv4 address"},"DataIPv6Address":{"type":"string","title":"The VM's data IPv6 address"},"NodeType":{"type":"string","title":"The Cw VM Node type. One of Management, Worker, Hybrid"},"VMName":{"type":"string","title":"The VM Name"},"CwImage":{"type":"string","title":"The VM Image"},"Cluster_Id":{"type":"string","title":"The VM's Cluster ID"},"HostDataCentre":{"type":"object","properties":{"DataCentre_Id":{"type":"string","title":"The VM's DataCentre ID"},"Host":{"type":"string","title":"Virtualization host name"},"Datastore":{"type":"string","title":"Datastore name"},"HSDatastore":{"type":"string","title":"High Speed Datastore name"}},"example":{"DataCentre_Id":"dc1","Host":"host1.example.com","Datastore":"mainDatastore","HSDatastore":"highSpeedDatastore1"},"$$ref":"#/definitions/CwVMDataCentre"},"Op_Status":{"title":"Operational Status - ignored in requests","type":"string","enum":["Initializing","Down","Running","Degraded","Erased","Failed","Suspended","Configuring","Erasing"],"default":"Initializing","example":"Running","$$ref":"#/definitions/install_apiCwVmState"},"VmSize":{"type":"string","title":"VM Size"}},"example":{"ManagementIPAddress":"10.0.0.100","ManagementIPv4Address":"10.0.0.100","ManagementIPv6Address":"2001:db8::100","DataIPAddress":"10.0.1.100","DataIPv4Address":"10.0.1.100","DataIPv6Address":"2001:db8::101","NodeType":"Management","VMName":"vm1","CwImage":"centos-7","Cluster_Id":"cluster1","HostDataCentre":{"DataCentre_Id":"dc1","Host":"host1.example.com","Datastore":"mainDatastore","HSDatastore":"highSpeedDatastore1"},"Op_Status":"Running","VmSize":"Large"},"$$ref":"#/definitions/install_apiCwVM"}}],"tags":["CwVmMangager"],"__originalOperationId":"CwVmMangager_AddCwVM","consumes":["application/json"],"produces":["application/json"],"security":[{"bearerAuth":[]}],"method":"post","path":"/node-manager/vms/add"}}