Get Cloud Spec Template
Get Cloud Specification Template.
Request
URI
GET
https://{api_host}/hybridity/api/ztp/scheme1/template
COPY
Responses
200
Ok
Returns InlineZtpScheme1Template200Response of type(s) application/json
{
"VCENTER": [
{
"id": "string",
"version": 0,
"name": "vCenter-001",
"type": "string",
"location": {
"city": "string",
"country": "string",
"address": "string",
"longitude": "number",
"latitude": "number"
},
"licenses": {
"esxi": [
"string"
],
"vsan": [
"string"
]
},
"datacenter": "string",
"vcenter": {
"fqdn": "string",
"username": "string",
"password": "string",
"thumbprintSha256": "06:69:51:27:c6:bc:32:3e:02:a4:e4:3c:2e:9e:75:78:9e:b7:d4:9c:11:51:72:cc:c4:45:13:22:a4:36:f3:e5"
}
}
],
"COMPUTE_CLUSTER": [
{
"id": "string",
"version": 0,
"name": "cdc1-cc1",
"type": "string",
"enabled": false,
"parentDomainId": "string",
"location": {
"city": "string",
"country": "string",
"address": "string",
"longitude": "number",
"latitude": "number"
},
"licenses": {
"esxi": [
"string"
],
"vsan": [
"string"
]
},
"switches": [
{
"name": "string",
"uplinks": [
{
"pnic": "string",
"name": "string"
}
]
}
],
"services": [
{
"name": "string",
"type": "string",
"enabled": false,
"vsanConfig": {
"vsanDedup": false
}
}
],
"storage": {
"twoNodeVsanCluster": {
"witness": {
"preDeployed": {
"witnessHostAddress": "string"
},
"ztpDeployed": {
"ovaPath": "string",
"witnessVMDeployment": {
"formFactor": "string",
"deploymentTarget": {
"clusterName": "string",
"resourceGroup": "string",
"hostName": "string"
},
"dataStoreName": "string",
"primaryNetwork": {
"networkName": "string",
"fqdn": "string",
"gateway": "string",
"prefix": 0
},
"secondaryNetwork": {
"networkName": "string",
"fqdn": "string",
"gateway": "string",
"prefix": 0
},
"rootPassword": "string"
}
}
}
}
},
"networks": [
{
"type": "string",
"name": "string",
"switch": "string",
"segmentType": "string",
"vlan": 0,
"mtu": 0,
"gateway": "string",
"prefixLength": 0,
"mac_learning_enabled": false,
"uplinkTeamingPolicy": {
"uplinkPortOrder": {
"active": [
"string"
],
"standby": [
"string"
],
"unused": [
"string"
]
}
}
}
],
"settings": {
"dns": {
"suffix": "string",
"servers": [
"string"
]
},
"ntp": {
"servers": [
"string"
]
},
"csiTagging": {
"enableCsiZoning": false,
"clusterCsiZoneTagNamingScheme": "string",
"hostCsiZoneTagNamingScheme": "string"
},
"disableDatastoreCustomization": false
},
"csiTags": {
"csiZoneTag": "string"
},
"csiCategories": {
"useExisting": false,
"zone": "string"
},
"hcpId": "string"
}
],
"CELL_SITE_GROUP": [
{
"id": "string",
"version": 0,
"name": "cdc1-csg1",
"type": "string",
"enabled": false,
"preDeployed": {
"preDeployed": false
},
"parentDomainId": "string",
"switches": [
{
"name": "string",
"uplinks": [
{
"pnic": "string",
"name": "string"
}
]
}
],
"networks": [
{
"type": "string",
"name": "string",
"switch": "string",
"segmentType": "string",
"vlan": 0,
"mac_learning_enabled": false,
"uplinkTeamingPolicy": {
"uplinkPortOrder": {
"active": [
"string"
],
"standby": [
"string"
],
"unused": [
"string"
]
}
}
}
],
"settings": {
"dns": {
"suffix": "string",
"servers": [
"string"
]
},
"ntp": {
"servers": [
"string"
]
},
"csiTagging": {
"enableCsiZoning": false,
"clusterCsiZoneTagNamingScheme": "string",
"hostCsiZoneTagNamingScheme": "string"
},
"disableDatastoreCustomization": false
},
"csiTags": {
"csiZoneTag": "string"
},
"csiCategories": {
"useExisting": false,
"zone": "string"
},
"hcpId": "string"
}
],
"settings": {
"ssoDomain": "string",
"pscUserGroup": "string",
"saas": "string",
"enableCsiZoning": false,
"validateCloudBuilderSpec": false,
"csiRegionTagNamingScheme": "string",
"clusterCsiZoneTagNamingScheme": "string",
"hostCsiZoneTagNamingScheme": "string",
"dnsSuffix": "string",
"airgapServer": {
"fqdn": "string",
"caCert": "string"
},
"ntpServers": [
"string"
],
"dnsServers": [
"string"
],
"applianceNamingScheme": "string",
"proxy": {
"server": "string",
"protocol": "string",
"port": 0,
"username": "string",
"password": "string",
"enabled": false,
"exclusions": [
"string"
]
},
"appliancesSharedWithManagementDomain": [
{
"type": "string",
"enabled": false
}
],
"tcaSsoCredentials": {
"username": "administrator@vsphere.local",
"password": "string"
},
"_comments": [
"string"
]
},
"appliances": [
{
"type": "string",
"id": "string",
"name": "string",
"ipIndex": 0,
"parent": "string",
"rootPassword": "string",
"adminPassword": "string",
"auditPassword": "string",
"clusterPassword": "string",
"size": "string",
"tier0Mode": "string",
"ipIndexPool": [
{
"start": 0,
"end": 0
}
],
"nodeCount": 0,
"enabled": false,
"shares": [
{
"name": "string",
"quotaInMb": 0
}
],
"_comments": [
"string"
]
}
],
"images": {
"cloudbuilder": "string",
"vro": "string",
"tca": "string",
"haproxy": [
"string"
],
"kube": [
"string"
],
"vsphere_plugin": "string",
"vrli": "string"
},
"_comments": [
"string"
],
"deleteDomains": [
"string"
],
"hostProfiles": [
{
"name": "string",
"biosSetting": {
"attributes": [
{
"key": "string",
"value": "string"
}
]
},
"firmwares": [
{
"name": "string",
"softwareId": "string",
"version": "string",
"location": "string",
"checksum": "string"
}
],
"pciDevices": [
{
"filters": [
{
"numaId": 0,
"vendorId": "string",
"deviceIds": [
"string"
],
"indices": [
0
],
"alias": "string"
}
],
"actions": [
{
"type": "string",
"maxVfs": 0,
"passthroughEnabled": false,
"deviceType": "string",
"attributes": [
{
"key": "string",
"value": "string"
}
]
}
]
}
],
"pciGroups": [
{
"name": "string",
"filters": [
{
"isVf": false,
"deviceIds": [
"string"
],
"vendorId": "string",
"sriovEnabled": false,
"numaId": 0,
"indices": [
0
],
"alias": "string"
}
]
}
],
"reservation": {
"reservedCoresPerNumaNode": 0,
"reservedMemoryPerNumaNode": 0,
"minCoresForCPUReservationPerNumaNode": 0
}
}
]
}array of object
VCENTER
Optional
VCENTER
array of object
COMPUTE_CLUSTER
Optional
COMPUTE_CLUSTER
array of object
CELL_SITE_GROUP
Optional
CELL_SITE_GROUP
object
settings
Optional
settings
array of object
appliances
Optional
appliances
object
images
Optional
images
array of string
_comments
Optional
_comments
array of string
deleteDomains
Optional
deleteDomains
array of object
hostProfiles
Optional
hostProfiles
301
API endpoint has permanently moved.
Returns InlineZtpScheme1Template301Response of type(s) application/json
{
"redirectURL": "string"
}string
redirectURL
Optional
redirectURL
Response Headers
string
Location
URI where the client will find the new endpoint.
400
Bad Request received.
Returns InlineZtpScheme1Template400Response of type(s) application/json
{
"warnings": [
{
"code": "string",
"message": "string",
"stack": "string"
}
],
"errors": [
{
"code": "string",
"message": "string",
"stack": "string"
}
]
}array of object
warnings
Optional
The list of warnings.
array of object
errors
Optional
The list of errors.
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
500
An Internal Server Error has occurred.
Returns InlineZtpScheme1Template500Response of type(s) application/json
{
"warnings": [
{
"code": "string",
"message": "string",
"stack": "string"
}
],
"errors": [
{
"code": "string",
"message": "string",
"stack": "string"
}
]
}array of object
warnings
Optional
The list of warnings.
array of object
errors
Optional
The list of errors.
Cloud Specification Operations
GET
Get Cloud Spec Template