VMware Cloud Assembly IaaS API Data Structures
State object representing an about page that includes api versioning information
{
"supportedApis": [
{
"apiVersion": "string",
"deprecationPolicy": {
"deprecatedAt": "string",
"description": "string",
"expiresAt": "string"
},
"documentationLink": "string"
}
],
"latestApiVersion": "string"
}
A collection of all currently supported api versions.
The latest version of the API in yyyy-MM-dd format (UTC).
{
"apiVersion": "string",
"deprecationPolicy": {
"deprecatedAt": "string",
"description": "string",
"expiresAt": "string"
},
"documentationLink": "string"
}
The version of the API in yyyy-MM-dd format (UTC).
The link to the documentation of this api version
Entity that holds auth token details.
{
"tokenType": "Bearer",
"token": "string"
}
Type of the token.
Base64 encoded auth token.
Defines a structure that holds list of storage policies defined for AWS for a specific region.HATEOAS links:
region - Region - Region for the profile.
self - AwsStorageProfile - Self link to this aws Storage Profile
{
"owner": "[email protected]",
"deviceType": "ebs / instance-store",
"volumeType": "gp2 / io1 / sc1 / st1 / standard",
"supportsEncryption": "boolean",
"externalRegionId": "us-east-1",
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"name": "my-name",
"iops": "2000",
"id": "9e49",
"defaultItem": "boolean",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
Indicates the type of storage device.
Indicates the type of volume associated with type of storage device.
HATEOAS of the entity
Indicates whether this storage profile supports encryption or not.
The id of the region for which this profile is defined
A human-friendly description.
The id of the organization this entity belongs to.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
A human-friendly name used as an identifier in APIs that support this option.
Indicates maximum I/O operations per second in range(1-20,000).
The id of this resource instance
Indicates whether this storage profile is default or not..
Date when the entity was last updated. The date is ISO 8601 and UTC.
Defines a structure that holds list of storage policies defined for Azure for a specific region.HATEOAS links:
storage-account - FabricAzureStorageAccount - Storage account for the profile.
region - Region - Region for the profile.
self - AzureStorageProfile - Self link to this Azure storage profile.
{
"owner": "[email protected]",
"supportsEncryption": "boolean",
"externalRegionId": "uswest",
"description": "my-description",
"dataDiskCaching": "None / ReadOnly / ReadWrite",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"name": "my-name",
"id": "9e49",
"defaultItem": "boolean",
"diskType": "Standard_LRS / Premium_LRS",
"osDiskCaching": "None / ReadOnly / ReadWrite",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
HATEOAS of the entity
Indicates whether this storage profile should support encryption or not.
The id of the region for which this profile is defined
A human-friendly description.
Indicates the caching mechanism for additional disk.
The id of the organization this entity belongs to.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
Indicates if a storage profile contains default storage properties.
Indicates the performance tier for the storage type. Premium disks are SSD backed and Standard disks are HDD backed.
Indicates the caching mechanism for OS disk. Default policy for OS disks is Read/Write.
Date when the entity was last updated. The date is ISO 8601 and UTC.
State object representing a block device.
HATEOAS links:
cloud-accounts - array[CloudAccount] - Cloud accounts where this disk is provisioned.
self - BlockDevice - Self link to this block device
{
"owner": "[email protected]",
"externalZoneId": "us-east-1a",
"externalRegionId": "us-east-1",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"capacityInGB": 10,
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"deploymentId": "123e4567-e89b-12d3-a456-426655440000",
"name": "my-name",
"id": "9e49",
"persistent": true,
"projectId": "9e49",
"updatedAt": "2012-09-27",
"status": "ATTACHED"
}
Email of the user that owns the entity.
HATEOAS of the entity
The external zoneId of the resource.
The external regionId of the resource
A human-friendly description.
External entity Id on the provider side.
The id of the organization this entity belongs to.
A set of tag keys and optional values that were set on this resource instance.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Capacity of the block device in GB.
Date when the entity was created. The date is in ISO 8601 and UTC.
Set of ids of the cloud accounts this entity belongs to.
Additional properties that may be used to extend the base type.
Deployment id that is associated with this resource
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
Indicates whether the block device is persistent or not.
The id of the project this entity belongs to.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Status of the block device
State object representing a query result of block device.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"externalZoneId": "us-east-1a",
"externalRegionId": "us-east-1",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"capacityInGB": 10,
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"deploymentId": "123e4567-e89b-12d3-a456-426655440000",
"name": "my-name",
"id": "9e49",
"persistent": true,
"projectId": "9e49",
"updatedAt": "2012-09-27",
"status": "ATTACHED"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
{
"capacityInGB": 78,
"sourceReference": "ami-0d4cfd66",
"encrypted": true,
"deploymentId": "123e4567-e89b-12d3-a456-426655440000",
"name": "string",
"description": "string",
"diskContentBase64": "dGVzdA",
"persistent": true,
"projectId": "e058",
"constraints": [
{
"expression": "ha:strong",
"mandatory": "boolean"
}
],
"tags": [
{
"value": "string",
"key": "string"
}
]
}
Capacity of the block device in GB.
Reference to URI using which the block device has to be created.
Additional custom properties that may be used to extend the block device.
Indicates whether the block device should be encrypted or not.
The id of the deployment that is associated with this resource
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Content of a disk, base64 encoded.
Indicates whether the block device should be persistent or not.
The id of the project the current user belongs to.
Constraints that are used to drive placement policies for the block device that is produced from this specification. Constraint expressions are matched against tags on existing placement targets.
A set of tag keys and optional values that should be set on any resource that is produced from this specification.
State object representing a cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
HATEOAS links:
associated-cloud-accounts - array[CloudAccount] - Cloud accounts associated to this cloud account. For example an NSX endpoint linked to a vSphere cloud account.
regions - array[Region] - List of regions that are enabled for this cloud account.
self - CloudAccount - Self link to this cloud account
{
"owner": "[email protected]",
"enabledRegionIds": [
"string"
],
"cloudAccountType": "vsphere, aws, azure, nsxv, nsxt",
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
Cloud account specific properties
A set of region names to enable provisioning on.
HATEOAS of the entity
Cloud account type
A human-friendly description.
The id of the organization this entity belongs to.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Additional properties that may be used to extend the base type.
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
Date when the entity was last updated. The date is ISO 8601 and UTC.
State object representing a AWS cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
HATEOAS links:
regions - array[Region] - List of regions that are enabled for this cloud account.
self - CloudAccountAws - Self link to this cloud account
{
"owner": "[email protected]",
"accessKeyId": "KLIKJ7EA4PPDZR7T7Z6K",
"enabledRegionIds": [
"string"
],
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
Access key id for Aws.
A set of region names that are enabled for this cloud account.
HATEOAS of the entity
A human-friendly description.
The id of the organization this entity belongs to.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Additional properties that may be used to extend the base type.
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
Date when the entity was last updated. The date is ISO 8601 and UTC.
State object representing a query result of Aws cloud accounts.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"accessKeyId": "KLIKJ7EA4PPDZR7T7Z6K",
"enabledRegionIds": [
"string"
],
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Specification for a Amazon cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
{
"accessKeyId": "ACDC55DB4MFH6ADG75KK",
"secretAccessKey": "gfsScK345sGGaVdds222dasdfDDSSasdfdsa34fS",
"createDefaultZones": true,
"name": "string",
"description": "string",
"regionIds": [
"string"
],
"tags": [
{
"value": "string",
"key": "string"
}
]
}
Aws Access key ID
Aws Secret Access Key
Create default cloud zones for the enabled regions.
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
A set of Region names to enable provisioning on. Refer to /iaas/cloud-accounts-aws/region-enumeration..
State object representing an Azure cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
HATEOAS links:
regions - array[Region] - List of regions that are enabled for this cloud account.
self - CloudAccountAzure - Self link to this cloud account
{
"owner": "[email protected]",
"enabledRegionIds": [
"string"
],
"clientApplicationId": "66f277f2-ff12-4c3a-a4c9-b13d131a9a4d",
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"name": "my-name",
"tenantId": "027f73d5-0a19-452e-9d45-775693421508",
"id": "9e49",
"subscriptionId": "f3c86a85-e379-42ae-a8ba-7a51382d6dd7",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
A set of region names that are enabled for this cloud account.
HATEOAS of the entity
Azure Client Application IDaccount.
A human-friendly description.
The id of the organization this entity belongs to.
A set of tag keys and optional values that were set on on the Cloud Account
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Additional properties that may be used to extend the base type.
A human-friendly name used as an identifier in APIs that support this option.
Azure Tenant Idaccount.
The id of this resource instance
Azure Subscription IDaccount.
Date when the entity was last updated. The date is ISO 8601 and UTC.
State object representing a query result of Azure cloud accounts.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"enabledRegionIds": [
"string"
],
"clientApplicationId": "66f277f2-ff12-4c3a-a4c9-b13d131a9a4d",
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"name": "my-name",
"tenantId": "027f73d5-0a19-452e-9d45-775693421508",
"id": "9e49",
"subscriptionId": "f3c86a85-e379-42ae-a8ba-7a51382d6dd7",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Specification for a Azure cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
{
"createDefaultZones": true,
"clientApplicationId": "3287dd6e-76d8-41b7-9856-2584969e7739",
"clientApplicationSecretKey": "GDfdasDasdASFas321das32cas2x3dsXCSA76xdcasg=",
"name": "string",
"tenantId": "9a13d920-4691-4e2d-b5d5-9c4c1279bc9a",
"description": "string",
"regionIds": [
"string"
],
"subscriptionId": "064865b2-e914-4717-b415-8806d17948f7",
"tags": [
{
"value": "string",
"key": "string"
}
]
}
Create default cloud zones for the enabled regions.
Azure Client Application ID
Azure Client Application Secret Key
A human-friendly name used as an identifier in APIs that support this option.
Azure Tenant ID
A human-friendly description.
A set of Region names to enable provisioning on. Refer to /iaas/cloud-accounts-azure/region-enumeration..
Azure Subscribtion ID
State object representing a GCP cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region where the associated cloud account resources are hosted.
HATEOAS links:
regions - array[Region] - List of regions that are enabled for this cloud account.
self - CloudAccountGcp - Self link to this cloud account
{
"owner": "[email protected]",
"enabledRegionIds": [
"string"
],
"clientEmail": "[email protected]",
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"name": "my-name",
"id": "9e49",
"projectId": "example-gcp-project",
"privateKeyId": "027f73d50a19452eedf5775a9b42c5083678abdf",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
A set of region names that are enabled for this
HATEOAS of the entity
GCP Client email
A human-friendly description.
The id of the organization this entity belongs to.
A set of tag keys and optional values that were set on on the Cloud Account
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Additional properties that may be used to extend the base type.
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
GCP Project ID
GCP Private key ID
Date when the entity was last updated. The date is ISO 8601 and UTC.
State object representing a query result of GCP cloud accounts.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"enabledRegionIds": [
"string"
],
"clientEmail": "[email protected]",
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"name": "my-name",
"id": "9e49",
"projectId": "example-gcp-project",
"privateKeyId": "027f73d50a19452eedf5775a9b42c5083678abdf",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Specification for a GCP cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region where the associated cloud account resources are hosted.
{
"privateKey": "-----BEGIN PRIVATE KEY-----\nMIICXgIHAASBgSDHikastc8+I81zCg/qWW8dMr8mqvXQ3qbPAmu0RjxoZVI47tvs\nkYlFAXOf0sPrhO2nUuooJngnHV0639iTTEYG1vckNaW2R6U5QTdQ5Rq5u+uV3pMk\n7w7Vs4n3urQ4jnqt7rTXbC1DNa/PFeAZatbf7ffBBy0IGO0zc128IshYcwIDAQAB\nAoGBALTNl2JxTvq4SDW/3VH0fZkQXWH1MM10oeMbB2qO5beWb11FGaOO77nGKfWc\nbYgfp5Ogrql2yhBvLAXnxH8bcqqwORtFhlyV68U1y4R+8WxDNh0aevxH8hRS/1X5\n963DJm1JlU0E+vStiktN0tC3ebH5hE+1OxbIHSZ+WOWLYX7JAkEA5uigRgKp8ScG\nauUijvdOLZIhHWq9y5Wz+nOHUuDw8P7wOTKU34QJAoWEe771p9Pf/GTA/kr0BQnP\nQvWUDxGzJwJBAN05C6krwPeryFKrKtjOGJIbiIoY72wRnoNcdEEs3HDRhf48YWFo\nriRbZylzzzNFy/gmzT6XJQTfktGqq+FZD9UCQGIJaGrxHJgfmpDuAhMzGsUsYtTr\niRox0D1Iqa7dhE693t5aBG010OF6MLqdZA1CXrn5SRtuVVaCSLZEL/2J5UcCQQDA\nd3MXucNnN4NPuS/L9HMYJWD7lPoosaORcgyK77bSSNgk+u9WSjbH1uYIAIPSffUZ\nbti+jc2dUg5wb+aeZlgJAkEAurrpmpqj5vg087ZngKfFGR5rozDiTsK5DceTV97K\na1Y+Nzl+XWTxDBWk4YPh2ZlKv402hZEfWBYxUDn5ZkH/bw==\n-----END PRIVATE KEY-----\n",
"createDefaultZones": true,
"clientEmail": "[email protected]",
"name": "string",
"description": "string",
"regionIds": [
"string"
],
"projectId": "example-gcp-project",
"privateKeyId": "027f73d50a19452eedf5775a9b42c5083678abdf",
"tags": [
{
"value": "string",
"key": "string"
}
]
}
GCP Private key
Create default cloud zones for the enabled regions.
GCP Client email
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
A set of Region names to enable provisioning on. Refer to /iaas/cloud-accounts-gcp/region-enumeration.
GCP Project ID
GCP Private key ID
State object representing an Nsx-T cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
HATEOAS links:
self - CloudAccountNsxT - Self link to this cloud account
{
"owner": "[email protected]",
"hostName": "nsxt.vmware.com",
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27",
"username": "[email protected]"
}
Email of the user that owns the entity.
Host name for the Nsx-T cloud account
HATEOAS of the entity
A human-friendly description.
The id of the organization this entity belongs to.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Additional properties that may be used to extend the base type.
Identifier of a data collector vm deployed in the on premise infrastructure.
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
Date when the entity was last updated. The date is ISO 8601 and UTC.
Username to authenticate with the cloud account
State object representing a query result of Nsx-T cloud accounts.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"hostName": "nsxt.vmware.com",
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27",
"username": "[email protected]"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Specification for an Nsx-T cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
{
"hostName": "nsxt.mycompany.com",
"acceptSelfSignedCertificate": "boolean",
"password": "cndhjslacd90ascdbasyoucbdh",
"dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
"name": "string",
"description": "string",
"username": "[email protected]",
"tags": [
{
"value": "string",
"key": "string"
}
]
}
Host name for the Nsx-T endpoint
Accept self signed certificate when connecting.
Password for the user used to authenticate with the cloud Account
Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Username to authenticate with the cloud account
State object representing an Nsx-V cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
HATEOAS links:
self - CloudAccountNsxV - Self link to this cloud account
{
"owner": "[email protected]",
"hostName": "nsxv.vmware.com",
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27",
"username": "[email protected]"
}
Email of the user that owns the entity.
Host name for the Nsx-V cloud account
HATEOAS of the entity
A human-friendly description.
The id of the organization this entity belongs to.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Additional properties that may be used to extend the base type.
Identifier of a data collector vm deployed in the on premise infrastructure.
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
Date when the entity was last updated. The date is ISO 8601 and UTC.
Username to authenticate with the cloud account
State object representing a query result of Nsx-V cloud accounts.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"hostName": "nsxv.vmware.com",
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27",
"username": "[email protected]"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Specification for an Nsx-V cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
{
"hostName": "nsxv.mycompany.com",
"acceptSelfSignedCertificate": "boolean",
"password": "cndhjslacd90ascdbasyoucbdh",
"dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
"name": "string",
"description": "string",
"username": "[email protected]",
"tags": [
{
"value": "string",
"key": "string"
}
]
}
Host name for the Nsx-T endpoint
Accept self signed certificate when connecting.
Password for the user used to authenticate with the cloud Account
Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Username to authenticate with the cloud account
State object representing a cloud account region.
{
"externalRegionIds": [
"string"
]
}
A set of region ids for the cloud account.
State object representing a query result of cloud accounts.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"enabledRegionIds": [
"string"
],
"cloudAccountType": "vsphere, aws, azure, nsxv, nsxt",
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Specification for a generic cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
{
"privateKey": "gfsScK345sGGaVdds222dasdfDDSSasdfdsa34fS",
"associatedCloudAccountIds": [
"string"
],
"createDefaultZones": true,
"cloudAccountType": "vsphere, aws, azure, nsxv, nsxt",
"name": "string",
"description": "string",
"regionIds": [
"string"
],
"privateKeyId": "ACDC55DB4MFH6ADG75KK",
"tags": [
{
"value": "string",
"key": "string"
}
]
}
Cloud Account specific properties supplied in as name value pairs
Secret access key or password to be used to authenticate with the cloud account
Cloud account to link with this cloud account
Create default cloud zones for the enabled regions.
Additional custom properties that may be used to extend the Cloud Account.
Cloud account type
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
A set of Region names to enable provisioning on.Refer to /iaas/cloud-accounts/region-enumeration.
Access key id or username to be used to authenticate with the cloud account
State object representing a Vmc cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
HATEOAS links:
regions - array[Region] - List of regions that are enabled for this cloud account.
self - CloudAccountVmc - Self link to this cloud account
{
"owner": "[email protected]",
"sddc": "string",
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"createDefaultZones": true,
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27",
"username": "[email protected]"
}
Email of the user that owns the entity.
HATEOAS of the entity
SDDC environment.
A human-friendly description.
The id of the organization this entity belongs to.
A set of tag keys and optional values to set on the Cloud Account.Cloud account capability tags may enable different features.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Create default cloud zones for the enabled regions.
Additional properties that may be used to extend the base type.
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
Date when the entity was last updated. The date is ISO 8601 and UTC.
Username to authenticate to vCenter
State object representing a query result of Vmc cloud accounts.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"sddc": "string",
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"createDefaultZones": true,
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27",
"username": "[email protected]"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Specification for a VMC cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
{
"hostName": "vc1.vmware.com",
"acceptSelfSignedCertificate": "boolean",
"apiKey": "string",
"nsxHostName": "nsxManager.sddc-52-12-8-145.vmwaretest.com",
"sddcId": "CMBU-PRD-NSXT-M8GA-090319",
"description": "string",
"regionIds": [
"string"
],
"tags": [
{
"value": "string",
"key": "string"
}
],
"password": "cndhjslacd90ascdbasyoucbdh",
"createDefaultZones": true,
"dcId": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
"name": "string",
"username": "[email protected]"
}
Enter the IP address or FQDN of the vCenter Server in the specified SDDC. The cloud proxy belongs on this vCenter.
Accept self signed certificate when connecting to vSphere
VMC API access key
The IP address of the NSX Manager server in the specified SDDC / FQDN.
Identifier of the on-premise SDDC to be used by this cloud account. Note that NSX-V SDDCs are not supported.
A human-friendly description.
A set of Region names to enable provisioning on.Refer to /iaas/cloud-accounts/region-enumeration.
A set of tag keys and optional values to set on the Cloud Account.Cloud account capability tags may enable different features.
Password for the user used to authenticate with the cloud Account
Create default cloud zones for the enabled regions.
Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors
A human-friendly name used as an identifier in APIs that support this option.
vCenter user name for the specified SDDC.The specified user requires CloudAdmin credentials. The user does not require CloudGlobalAdmin credentials.
State object representing a vSphere cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
HATEOAS links:
regions - array[Region] - List of regions that are enabled for this cloud account.
self - CloudAccountVsphere - Self link to this cloud account.
{
"owner": "[email protected]",
"hostName": "vc1.vmware.com",
"enabledRegionIds": [
"string"
],
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27",
"username": "[email protected]"
}
Email of the user that owns the entity.
Host name for the vSphere cloud account
A set of region names that are enabled for this cloud account.
HATEOAS of the entity
A human-friendly description.
The id of the organization this entity belongs to.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Additional properties that may be used to extend the base type.
Identifier of a data collector vm deployed in the on premise infrastructure.
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
Date when the entity was last updated. The date is ISO 8601 and UTC.
Username to authenticate with the cloud account
State object representing a query result of vSphere cloud accounts.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"hostName": "vc1.vmware.com",
"enabledRegionIds": [
"string"
],
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27",
"username": "[email protected]"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Specification for a vSphere cloud account.
A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
{
"hostName": "vc.mycompany.com",
"acceptSelfSignedCertificate": "boolean",
"associatedCloudAccountIds": [
"string"
],
"password": "cndhjslacd90ascdbasyoucbdh",
"createDefaultZones": true,
"dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
"name": "string",
"description": "string",
"regionIds": [
"string"
],
"username": "[email protected]",
"tags": [
{
"value": "string",
"key": "string"
}
]
}
Host name for the vSphere endpoint
Accept self signed certificate when connecting to vSphere
Cloud accounts to associate with this cloud account
Password for the user used to authenticate with the cloud Account
Create default cloud zones for the enabled regions.
Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
A set of datacenter managed object reference identifiers (MoRef) to enable provisioning on. Refer to /iaas/cloud-accounts-vsphere/region-enumeration.
Username to authenticate with the cloud account
A constraint that is conveyed to the policy engine.
{
"expression": "ha:strong",
"mandatory": "boolean"
}
An expression of the form "[!]tag-key[:[tag-value]]", used to indicate a constraint match on keys and values of tags.
Indicates whether this constraint should be strictly enforced or not.
Specification for token retrieval request.
{
"refreshToken": "5e7c2c-9a9e-4b0-9339-a7f94"
}
Refresh token obtained from the UI
State object representing a data collector.
The data collector is an OVA tool that contains the credentials and protocols needed to create a connection between a data collector appliance on a host vCenter and a vCenter-based cloud account.
{
"hostName": "dc1-lnd.mycompany.com",
"dcId": "d5316b00-f3b8-4895-9e9a-c4b98649c2ca",
"ipAddress": "10.0.0.1",
"name": "Datacollector1",
"status": "ACTIVE, INACTIVE"
}
Data collector host name
Data collector identifier
Ip Address of the data collector VM
Data collector name
Current status of the data collector
Data collector registration object.
The supplied data collector is an OVA tool that contains the credentials and protocols needed to create a connection between a data collector appliance on a host vCenter and a vCenter-based cloud account. . The process of deploying data collector is:
1. Download the data collector ova from the "ovaLink".
2. Import the .ova file to the vCenter Server and start the installation.
3. When asked for the key, copy and use the "key" provided.
4. It takes a few minutes to detect your Data Collector after it is deployed and powered on in vCenter.
{
"ovaLink": "https://ci-data-collector.s3.amazonaws.com/VMware-Cloud-Services-Data-Collector.ova",
"key": "eyJyZWdpc3RyYXRpb25VcmwiOiJodHRwczovL2Fw"
}
Data collector OVA Link
A registration key for the data collector
State object representing a query result of data collectors.
{
"numberOfElements": 1,
"content": [
{
"hostName": "dc1-lnd.mycompany.com",
"dcId": "d5316b00-f3b8-4895-9e9a-c4b98649c2ca",
"ipAddress": "10.0.0.1",
"name": "Datacollector1",
"status": "ACTIVE, INACTIVE"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
State object representing a deployment.
HATEOAS links:
self - Deployment - Self link to this deployment
{
"owner": "[email protected]",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"name": "my-name",
"description": "my-description",
"id": "9e49",
"projectId": "string",
"orgId": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
The id of this resource instance
projectId
The id of the organization this entity belongs to.
Date when the entity was last updated. The date is ISO 8601 and UTC.
{
"name": "string",
"description": "string",
"projectId": "e058"
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
The id of the project the current user belongs to.
{
"deprecatedAt": "string",
"description": "string",
"expiresAt": "string"
}
The date the api was deprecated in yyyy-MM-dd format (UTC). Could be empty if the api is not deprecated.
A free text description that contains information about why this api is deprecated and how to migrate to a newer version.
The date the api support will be dropped in yyyy-MM-dd format (UTC). The api may still be available for use after that date but this is not guaranteed.
Specification for attaching disk to a machine
{
"blockDeviceId": "1298765",
"name": "string",
"description": "string"
}
The id of the existing block device
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Represents a structure that holds details of Azure endpoint's storage account.
HATEOAS links:
region - Region - Region for the storage account.
self - FabricAzureStorageAccount - Self link to this storage account
{
"owner": "[email protected]",
"externalRegionId": "westus",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"type": "Standard_LRS / Premium_LRS",
"orgId": "9e49",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
HATEOAS of the entity
Indicates the ID of region.
A human-friendly description.
External entity Id on the provider side.
Indicates the performance tier for the storage type. Premium disks are SSD backed and Standard disks are HDD backed.
The id of the organization this entity belongs to.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Set of ids of the cloud accounts this entity belongs to.
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
Date when the entity was last updated. The date is ISO 8601 and UTC.
State object representing a query result of Azure storage accounts.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"externalRegionId": "westus",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"type": "Standard_LRS / Premium_LRS",
"orgId": "9e49",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Represents a compute which is an entity on the cloud provider side that can be used to provision resources in. It could be an availability zone in a public cloud, cluster, host or resource pool in vSphere
{
"owner": "[email protected]",
"externalZoneId": "us-east-1a",
"externalRegionId": "us-east-1",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"type": "Availability Zone",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
HATEOAS of the entity
The external zoneId of the compute.
The external regionId of the compute
A human-friendly description.
External entity Id on the provider side.
Type of the compute instance
The id of the organization this entity belongs to.
A set of tag keys and optional values that were set on this resource instance.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
Date when the entity was last updated. The date is ISO 8601 and UTC.
State object representing a query result of cloud zone's computes.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"externalZoneId": "us-east-1a",
"externalRegionId": "us-east-1",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"type": "Availability Zone",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Represents a fabric flavor from the corresponding cloud end-point
{
"bootDiskSizeInMB": 486400,
"memoryInMB": 15616,
"name": "i3.large",
"storageType": "NVMe_SSD",
"id": "i3.large",
"dataDiskSizeInMB": 486400,
"dataDiskMaxCount": 1,
"networkType": "Up to 10 Gigabit",
"cpuCount": 2
}
Size of the boot disk (in megabytes). Not populated when inapplicable.
Total amount of memory (in megabytes). Not populated when inapplicable.
The value of the instance type in the corresponding cloud.
The type of storage supported by this instance type. Not populated when inapplicable.
The internal identification used by the corresponding cloud end-point
Size of the data disks (in megabytes). Not populated when inapplicable.
Number of data disks. Not populated when inapplicable.
The type of network supported by this instance type. Not populated when inapplicable.
Number of CPU cores. Not populated when inapplicable.
Represents fabric flavor instance type description. Used when creating flavor profiles.
{
"memoryInMB": 4096,
"name": "t2.small, t2.medium",
"cpuCount": 4
}
Total amount of memory (in megabytes). Mandatory for private clouds such as vSphere. Not populated when inapplicable.
The value of the instance type in the corresponding cloud. Valid and mandatory for public clouds
Number of CPU cores. Mandatory for private clouds such as vSphere. Not populated when inapplicable.
State object representing a query result of fabric flavors.
{
"numberOfElements": 1,
"content": [
{
"bootDiskSizeInMB": 486400,
"memoryInMB": 15616,
"name": "i3.large",
"storageType": "NVMe_SSD",
"id": "i3.large",
"dataDiskSizeInMB": 486400,
"dataDiskMaxCount": 1,
"networkType": "Up to 10 Gigabit",
"cpuCount": 2
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Represents a fabric image from the corresponding cloud end-point.
HATEOAS links:
region - Region - Region for the image.
self - FabricImage - Self link to this image
{
"owner": "[email protected]",
"osFamily": "linux, win",
"externalRegionId": "us-east-1",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"isPrivate": true,
"orgId": "9e49",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
Operating System family of the image.
HATEOAS of the entity
The regionId of the image
A human-friendly description.
External entity Id on the provider side.
Indicates whether this fabric image is private. For vSphere, private images are considered to be templates and snapshots and public are Content Library Items
The id of the organization this entity belongs to.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Set of ids of the cloud accounts this entity belongs to.
Additional properties that may be used to extend the base type.
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
Date when the entity was last updated. The date is ISO 8601 and UTC.
Represents fabric image description. Used when creating image profiles.
{
"cloudConfig": "runcmd:\n - [\"mkdir\", \"/imageFolder\"]",
"name": "ami-ubuntu-16.04-1.9.1-00-1516139717",
"id": "9e49",
"constraints": [
{
"expression": "ha:strong",
"mandatory": "boolean"
}
]
}
Cloud config for this image. This cloud config will be merged during provisioning with other cloud configurations such as the bootConfig provided in MachineSpecification.
Fabric image name. Valid if id not provided.
The id of the fabric image
Constraints that are used to drive placement policies for the image that is produced from this mapping.Constraint expressions are matched against tags on existing placement targets.
State object representing a query result of fabric images.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"osFamily": "linux, win",
"externalRegionId": "us-east-1",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"isPrivate": true,
"orgId": "9e49",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
State object representing a network on a external cloud provider.
HATEOAS links:
region - Region - Region for the network.
self - FabricNetwork - Self link to this network
{
"owner": "[email protected]",
"externalRegionId": "us-east-1",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"ipv6Cidr": "2001:eeee:6bd:2a::1/64",
"cloudAccountIds": [
"string"
],
"isDefault": "boolean",
"name": "my-name",
"isPublic": "boolean",
"cidr": "10.1.2.0/24",
"id": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
HATEOAS of the entity
The id of the region for which this network is defined
A human-friendly description.
External entity Id on the provider side.
The id of the organization this entity belongs to.
A set of tag keys and optional values that were set on this resource instance.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Network IPv6 CIDR to be used.
Set of ids of the cloud accounts this entity belongs to.
Indicates whether this is the default subnet for the zone.
A human-friendly name used as an identifier in APIs that support this option.
Indicates whether the sub-network supports public IP assignment.
Network CIDR to be used.
The id of this resource instance
Date when the entity was last updated. The date is ISO 8601 and UTC.
State object representing a query result of fabric networks.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"externalRegionId": "us-east-1",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"ipv6Cidr": "2001:eeee:6bd:2a::1/64",
"cloudAccountIds": [
"string"
],
"isDefault": "boolean",
"name": "my-name",
"isPublic": "boolean",
"cidr": "10.1.2.0/24",
"id": "9e49",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Specification for updating a FabricNetwork
{
"tags": [
{
"value": "string",
"key": "string"
}
]
}
A set of tag keys and optional values that were set on this resource instance.
State object representing a vSphere network on a external cloud provider.
domain - domain for the vSphere network.
defaultGateway - default IPv4 gateway for the vSphere network.
defaultIPv6Gateway - default IPv6 gateway for the vSphere network.
dnsServerAddresses - list of dns server address for the vSphere network.
dnsSearchDomains - ist of dns search domains for the vSphere network
{
"owner": "[email protected]",
"externalRegionId": "us-east-1",
"defaultIpv6Gateway": "2001:eeee:6bd:2a::1",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"defaultGateway": "10.1.2.1",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"ipv6Cidr": "2001:eeee:6bd:2a::1/64",
"cloudAccountIds": [
"string"
],
"isDefault": "boolean",
"domain": "sqa.local",
"dnsServerAddresses": [
"string"
],
"name": "my-name",
"isPublic": "boolean",
"cidr": "10.1.2.0/24",
"id": "9e49",
"updatedAt": "2012-09-27",
"dnsSearchDomains": [
"string"
]
}
Email of the user that owns the entity.
HATEOAS of the entity
The id of the region for which this network is defined
IPv6 default gateway to be used.
A human-friendly description.
External entity Id on the provider side.
IPv4 default gateway to be used.
The id of the organization this entity belongs to.
A set of tag keys and optional values that were set on this resource instance.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Network IPv6 CIDR to be used.
Set of ids of the cloud accounts this entity belongs to.
Indicates whether this is the default subnet for the zone.
Domain value.
A list of DNS server addresses that were set on this resource instance.
A human-friendly name used as an identifier in APIs that support this option.
Indicates whether the sub-network supports public IP assignment.
Network CIDR to be used.
The id of this resource instance
Date when the entity was last updated. The date is ISO 8601 and UTC.
A list of DNS search domains that were set on this resource instance.
State object representing a query result of fabric networks.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"externalRegionId": "us-east-1",
"defaultIpv6Gateway": "2001:eeee:6bd:2a::1",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"defaultGateway": "10.1.2.1",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"ipv6Cidr": "2001:eeee:6bd:2a::1/64",
"cloudAccountIds": [
"string"
],
"isDefault": "boolean",
"domain": "sqa.local",
"dnsServerAddresses": [
"string"
],
"name": "my-name",
"isPublic": "boolean",
"cidr": "10.1.2.0/24",
"id": "9e49",
"updatedAt": "2012-09-27",
"dnsSearchDomains": [
"string"
]
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Specification for updating a Vsphere FabricNetwork
{
"ipv6Cidr": "2001:eeee:6bd:2a::1/64",
"isDefault": "boolean",
"domain": "sqa.local",
"defaultIpv6Gateway": "2001:eeee:6bd:2a::1",
"dnsServerAddresses": [
"string"
],
"isPublic": "boolean",
"cidr": "10.1.2.0/24",
"defaultGateway": "10.1.2.1",
"tags": [
{
"value": "string",
"key": "string"
}
],
"dnsSearchDomains": [
"string"
]
}
Network IPv6 CIDR to be used.
Indicates whether this is the default subnet for the zone.
Domain value.
IPv6 default gateway to be used.
A list of DNS server addresses that were set on this resource instance.
Indicates whether the sub-network supports public IP assignment.
Network CIDR to be used.
IPv4 default gateway to be used.
A set of tag keys and optional values that were set on this resource instance.
A list of DNS search domains that were set on this resource instance.
Represents a structure that holds details of vSphere datastore.
HATEOAS links:
self - FabricVsphereDatastore - Self link to this data store
{
"owner": "[email protected]",
"freeSizeGB": "20",
"externalRegionId": "Datacenter:datacenter-2",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"type": "VMFS / NFS / StoragePod",
"orgId": "9e49",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
Indicates free size available in datastore.
HATEOAS of the entity
Id of datacenter in which the datastore is present.
A human-friendly description.
External entity Id on the provider side.
Type of datastore.
The id of the organization this entity belongs to.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Set of ids of the cloud accounts this entity belongs to.
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
Date when the entity was last updated. The date is ISO 8601 and UTC.
State object representing a query result of vSphere datastores.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"freeSizeGB": "20",
"externalRegionId": "Datacenter:datacenter-2",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"type": "VMFS / NFS / StoragePod",
"orgId": "9e49",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Represents a structure that holds details of vSphere storage policy.HATEOAS links:
self - FabricVsphereStoragePolicy - Self link to this storage policy
{
"owner": "[email protected]",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"externalRegionId": "Datacenter:datacenter-2",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"id": "9e49",
"orgId": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Set of ids of the cloud accounts this entity belongs to.
HATEOAS of the entity
Id of datacenter in which the storage policy is present.
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
External entity Id on the provider side.
The id of this resource instance
The id of the organization this entity belongs to.
Date when the entity was last updated. The date is ISO 8601 and UTC.
State object representing a query result of vSphere storage policies.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"externalRegionId": "Datacenter:datacenter-2",
"name": "my-name",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"id": "9e49",
"orgId": "9e49",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Describes a flavor mapping between a global fabric flavor key and fabric flavor.
HATEOAS links:
region - Region - Region for the mapping.
{
"externalRegionId": "us-east-1"
}
Flavors defined for the particular region. Keyed by global flavor key.
The id of the region for which this mapping is defined.
HATEOAS of the entity
Represents a structure that holds flavor mappings defined for the corresponding cloud end-point region.
HATEOAS links:
region - Region - Region for the profile.
self - FlavorProfile - Self link to this flavor profile
{
"owner": "[email protected]",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"flavorMappings": {
"externalRegionId": "us-east-1"
},
"externalRegionId": "us-east-1",
"name": "my-name",
"description": "my-description",
"id": "9e49",
"orgId": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
HATEOAS of the entity
The id of the region for which this profile is defined
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
The id of this resource instance
The id of the organization this entity belongs to.
Date when the entity was last updated. The date is ISO 8601 and UTC.
State object representing a query result of flavor profiles.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"flavorMappings": {
"externalRegionId": "us-east-1"
},
"externalRegionId": "us-east-1",
"name": "my-name",
"description": "my-description",
"id": "9e49",
"orgId": "9e49",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Specification for flavor profile
{
"regionId": "9e49",
"name": "string",
"description": "string"
}
The id of the region for which this profile is created
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Map between global fabric flavor keys
State object representing a query result of falvor mappings.
{
"numberOfElements": 1,
"content": [
{
"externalRegionId": "us-east-1"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Load balancer health check configuration.
{
"protocol": "HTTP, HTTPS",
"port": "80",
"timeoutSeconds": 5,
"unhealthyThreshold": 5,
"healthyThreshold": 2,
"urlPath": "/index.html",
"intervalSeconds": 60
}
The protocol used for the health check.
Port on the back-end instance machine to use for the health check.
Timeout (in seconds) to wait for a response from the back-end instance.
Number of consecutive check failures before considering a particular back-end instance as unhealthy.
Number of consecutive successful checks before considering a particular back-end instance as healthy.
URL path on the back-end instance against which a request will be performed for the health check. Useful when the health check protocol is HTTP/HTTPS.
Interval (in seconds) at which the health checks will be performed.
{
"hrefs": [
"string"
],
"href": "string"
}
hrefs
href
Describes an image mapping between image key and fabric image.
HATEOAS links:
region - Region - Region for the mapping.
{
"externalRegionId": "us-east-1"
}
Image mapping defined for the particular region.
The id of the region for which this mapping is defined.
HATEOAS of the entity
Represents a fabric image from the corresponding cloud end-point with additional cloud configuration script that will be executed on provisioning
{
"owner": "[email protected]",
"cloudConfig": "runcmd:\n - [\"mkdir\", \"/imageFolder\"]",
"osFamily": "linux, win",
"externalRegionId": "us-east-1",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"isPrivate": true,
"constraints": [
{
"expression": "ha:strong",
"mandatory": "boolean"
}
],
"orgId": "9e49",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
Cloud config for this image. This cloud config will be merged during provisioning with other cloud configurations such as the bootConfig provided in MachineSpecification.
Operating System family of the image.
HATEOAS of the entity
The regionId of the image
A human-friendly description.
External entity Id on the provider side.
Indicates whether this fabric image is private. For vSphere, private images are considered to be templates and snapshots and public are Content Library Items
Constraints that are used to drive placement policies for the image that is produced from this mapping.Constraint expressions are matched against tags on existing placement targets.
The id of the organization this entity belongs to.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Set of ids of the cloud accounts this entity belongs to.
Additional properties that may be used to extend the base type.
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
Date when the entity was last updated. The date is ISO 8601 and UTC.
Represents a structure that holds a list of image mappings defined for the particular region.
HATEOAS links:
region - Region - Region for the profile.
self - ImageProfile - Self link to this image profile
{
"owner": "[email protected]",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"externalRegionId": "us-east-1",
"imageMappings": {
"externalRegionId": "us-east-1"
},
"name": "my-name",
"description": "my-description",
"id": "9e49",
"orgId": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
HATEOAS of the entity
The id of the region for which this profile is defined
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
The id of this resource instance
The id of the organization this entity belongs to.
Date when the entity was last updated. The date is ISO 8601 and UTC.
State object representing a query result of image profiles.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"externalRegionId": "us-east-1",
"imageMappings": {
"externalRegionId": "us-east-1"
},
"name": "my-name",
"description": "my-description",
"id": "9e49",
"orgId": "9e49",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Specification for image profile.
{
"regionId": "9e49",
"name": "string",
"description": "string"
}
The id of the region for which this profile is created
Image mapping defined for the corresponding region.
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
State object representing a query result of image mappings.
{
"numberOfElements": 1,
"content": [
{
"externalRegionId": "us-east-1"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Represents a load balancer.
HATEOAS links:
load-balancer-targets - array[Machine] - List of load balancer target machines.
cloud-account - CloudAccount - Cloud account where this LB is deployed.
self - LoadBalancer - Self link to this load balancer
{
"owner": "[email protected]",
"address": "lb-123456789.eu-west-1.elb.amazonaws.com",
"externalZoneId": "us-east-1a",
"externalRegionId": "us-east-1",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"routes": [
{
"protocol": "TCP, UDP",
"port": "80",
"memberPort": "80",
"memberProtocol": "TCP, UDP",
"healthCheckConfiguration": {
"protocol": "HTTP, HTTPS",
"port": "80",
"timeoutSeconds": 5,
"unhealthyThreshold": 5,
"healthyThreshold": 2,
"urlPath": "/index.html",
"intervalSeconds": 60
}
}
],
"deploymentId": "123e4567-e89b-12d3-a456-426655440000",
"name": "my-name",
"id": "9e49",
"projectId": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
Primary address allocated or in use by this load balancer. The address could be an in the form of a publicly resolvable DNS name or an IP address.
HATEOAS of the entity
The external zoneId of the resource.
The external regionId of the resource
A human-friendly description.
External entity Id on the provider side.
The id of the organization this entity belongs to.
A set of tag keys and optional values that were set on this load balancer.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Set of ids of the cloud accounts this entity belongs to.
The load balancer route configuration regarding ports and protocols.
Additional properties that may be used to extend the base type.
Deployment id that is associated with this resource
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
The id of the project this entity belongs to.
Date when the entity was last updated. The date is ISO 8601 and UTC.
State object representing a query result of load balancecrs.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"address": "lb-123456789.eu-west-1.elb.amazonaws.com",
"externalZoneId": "us-east-1a",
"externalRegionId": "us-east-1",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"routes": [
{
"protocol": "TCP, UDP",
"port": "80",
"memberPort": "80",
"memberProtocol": "TCP, UDP",
"healthCheckConfiguration": {
"protocol": "HTTP, HTTPS",
"port": "80",
"timeoutSeconds": 5,
"unhealthyThreshold": 5,
"healthyThreshold": 2,
"urlPath": "/index.html",
"intervalSeconds": 60
}
}
],
"deploymentId": "123e4567-e89b-12d3-a456-426655440000",
"name": "my-name",
"id": "9e49",
"projectId": "9e49",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Load balancer configuration.
{
"routes": [
{
"protocol": "TCP, UDP",
"port": "80",
"memberPort": "80",
"memberProtocol": "TCP, UDP",
"healthCheckConfiguration": {
"protocol": "HTTP, HTTPS",
"port": "80",
"timeoutSeconds": 5,
"unhealthyThreshold": 5,
"healthyThreshold": 2,
"urlPath": "/index.html",
"intervalSeconds": 60
}
}
],
"deploymentId": "123e4567-e89b-12d3-a456-426655440000",
"targetLinks": [
"string"
],
"internetFacing": "boolean",
"name": "string",
"nics": [
{
"addresses": [
"string"
],
"securityGroupIds": [
"string"
],
"name": "string",
"description": "string",
"networkId": "dcd9",
"deviceIndex": 1
}
],
"description": "string",
"projectId": "e058",
"tags": [
{
"value": "string",
"key": "string"
}
]
}
The load balancer route configuration regarding ports and protocols.
Additional custom properties that may be used to extend the load balancer.
The id of the deployment that is associated with this resource
A list of links to target load balancer pool members. Links can be to either a machine or a machine's network interface.
An Internet-facing load balancer has a publicly resolvable DNS name, so it can route requests from clients over the Internet to the instances that are registered with the load balancer.
A human-friendly name used as an identifier in APIs that support this option.
A set of network interface specifications for this load balancer.
A human-friendly description.
The id of the project the current user belongs to.
A set of tag keys and optional values that should be set on any resource that is produced from this specification.
Represents a cloud agnostic machine.
HATEOAS links:
operations - array[String] - Supported operations for the machine.
network-interfaces - array[NetworkInterface] - Network interfaces for the machine.
disks - array[MachineDisk] - disks for the machine.
deployment - Deployment - Deployment that this machine is part of.
cloud-accounts - array[CloudAccount] - Cloud accounts where this machine is provisioned.
self - Machine - Self link to this machine
{
"owner": "[email protected]",
"address": "34.242.21.5",
"externalZoneId": "us-east-1a",
"externalRegionId": "us-east-1",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"powerState": "ON, OFF",
"deploymentId": "123e4567-e89b-12d3-a456-426655440000",
"name": "my-name",
"id": "9e49",
"projectId": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
Primary address allocated or in use by this machine. The actual type of the address depends on the adapter type. Typically it is either the public or the external IP address.
HATEOAS of the entity
The external zoneId of the resource.
The external regionId of the resource
A human-friendly description.
External entity Id on the provider side.
The id of the organization this entity belongs to.
A set of tag keys and optional values that were set on this resource instance.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Set of ids of the cloud accounts this entity belongs to.
Power state of machine.
Additional properties that may be used to extend the base type.
Deployment id that is associated with this resource
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
The id of the project this entity belongs to.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Machine boot config that will be passed to the instance that can be used to perform common automated configuration tasks and even run scripts after the instance starts.
{
"content": "#cloud-config\nrepo_update: true\nrepo_upgrade: all\n\npackages:\n - mysql-server\n\nruncmd:\n - sed -e '/bind-address/ s/^#*/#/' -i /etc/mysql/mysql.conf.d/mysqld.cnf\n - service mysql restart\n - mysql -e \"GRANT ALL PRIVILEGES ON *.* TO 'root'@'%' IDENTIFIED BY 'mysqlpassword';\"\n - mysql -e \"FLUSH PRIVILEGES;\"\n"
}
A valid cloud config data in json-escaped yaml syntax
State object representing a query result of machines.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"address": "34.242.21.5",
"externalZoneId": "us-east-1a",
"externalRegionId": "us-east-1",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"powerState": "ON, OFF",
"deploymentId": "123e4567-e89b-12d3-a456-426655440000",
"name": "my-name",
"id": "9e49",
"projectId": "9e49",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Specification for a cloud agnostic machine.
{
"image": "vmware-gold-master, ubuntu-latest, rhel-compliant, windows",
"disks": [
{
"blockDeviceId": "1298765",
"name": "string",
"description": "string"
}
],
"imageDiskConstraints": [
{
"expression": "ha:strong",
"mandatory": "boolean"
}
],
"description": "string",
"machineCount": 3,
"constraints": [
{
"expression": "ha:strong",
"mandatory": "boolean"
}
],
"tags": [
{
"value": "string",
"key": "string"
}
],
"flavor": "small, medium, large",
"deploymentId": "123e4567-e89b-12d3-a456-426655440000",
"bootConfig": {
"content": "#cloud-config\nrepo_update: true\nrepo_upgrade: all\n\npackages:\n - mysql-server\n\nruncmd:\n - sed -e '/bind-address/ s/^#*/#/' -i /etc/mysql/mysql.conf.d/mysqld.cnf\n - service mysql restart\n - mysql -e \"GRANT ALL PRIVILEGES ON *.* TO 'root'@'%' IDENTIFIED BY 'mysqlpassword';\"\n - mysql -e \"FLUSH PRIVILEGES;\"\n"
},
"name": "string",
"nics": [
{
"addresses": [
"string"
],
"securityGroupIds": [
"string"
],
"name": "string",
"description": "string",
"networkId": "dcd9",
"deviceIndex": 1
}
],
"imageRef": "ami-f6795a8c",
"remoteAccess": {
"password": "string",
"sshKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCu74dLkAGGYIgNuszEAM0HaS2Y6boTPw+HqsFmtPSOpxPQoosws/OWGZlW1uue6Y4lIvdRqZOaLK+2di5512etY67ZwFHc5h1kx4az433DsnoZhIzXEKKI+EXfH/w72CIyG/uVhIzmA4FvRVQKXinE1vaVen6v1CBQEZibx9RXrVRP1VRibsKFRXYxywNEl1VtPK7KaxCEYO9IXi4SKVulSAhOVequwjlo5E8bKNT61/g/YyMvwCbaTTPPeCpS/7i+JHYY3QZ8fQY/Syn+bOFpKCCHl+7VpsL8gjWe6fI4bUp6KUiW7ZkQpL/47rxawKnRMKKEU9P0ICp3RRB39lXT",
"keyPair": "string",
"authentication": "publicPrivateKey",
"username": "string"
},
"projectId": "e058"
}
Type of image used for this machine.
Constraints that are used to drive placement policies for the image disk. Constraint expressions are matched against tags on existing placement targets.
Describes machine within the scope of your organization and is not propagated to the cloud
Number of machines to provision - default 1.
Constraints that are used to drive placement policies for the virtual machine that is produced from this specification. Constraint expressions are matched against tags on existing placement targets.
A set of tag keys and optional values that should be set on any resource that is produced from this specification.
Flavor of machine instance.
Additional custom properties that may be used to extend the machine.
The id of the deployment that is associated with this resource
A human-friendly name used as an identifier in APIs that support this option.
A set of network interface controller specifications for this machine. If not specified, then a default network connection will be created.
Direct image reference used for this machine (name, path, location, uri, etc.). Valid if no image property is provided
The id of the project the current user belongs to.
The network object is an opaque reference to a logical network that network interfaces are attached to.
Based on settings specified by your cloud administrator, it may be a reference to an existing network, or be backed by an on-demand network created for isolation, or a security group that will be attached to machines as part of provisioning.
Networks are a limited resource, when it is not needed it should be deleted.
HATEOAS links:
self - Network - Self link to this network
{
"owner": "[email protected]",
"externalZoneId": "us-east-1a",
"externalRegionId": "us-east-1",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"deploymentId": "123e4567-e89b-12d3-a456-426655440000",
"name": "my-name",
"cidr": "10.10.0.0/16",
"id": "9e49",
"projectId": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
HATEOAS of the entity
The external zoneId of the resource.
The external regionId of the resource
A human-friendly description.
External entity Id on the provider side.
The id of the organization this entity belongs to.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Set of ids of the cloud accounts this entity belongs to.
Additional properties that may be used to extend the base type.
Deployment id that is associated with this resource
A human-friendly name used as an identifier in APIs that support this option.
IPv4 address range of the network in CIDR format
The id of this resource instance
The id of the project this entity belongs to.
Date when the entity was last updated. The date is ISO 8601 and UTC.
The network domain object is the parent of related subnets that are configured together. Subnets within a domain must have non-overlapping address spaces.
HATEOAS links:
cloud-accounts - array[CloudAccount] - List of cloud accounts where this network domain exists.
self - NetworkDomain - Self link to this network domain
{
"owner": "[email protected]",
"externalRegionId": "ap-northeast-2",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"name": "my-name",
"cidr": "10.0.0.0/8",
"id": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
HATEOAS of the entity
The external regionId of the network domain.
A human-friendly description.
External entity Id on the provider side.
The id of the organization this entity belongs to.
A set of tag keys and optional values that were set on this network domain.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Set of ids of the cloud accounts this entity belongs to.
Additional properties that may be used to extend the base type.
A human-friendly name used as an identifier in APIs that support this option.
IPv4 address range of the network domain in CIDR format
The id of this resource instance
Date when the entity was last updated. The date is ISO 8601 and UTC.
State object representing a query result of network domains.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"externalRegionId": "ap-northeast-2",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"name": "my-name",
"cidr": "10.0.0.0/8",
"id": "9e49",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
State object representing an IP address range for a Fabric Network.
HATEOAS links:
region - Region - Region for the network.
self - NetworkIPRange - Self link to this IP address range
{
"owner": "[email protected]",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"startIPAddress": "string",
"orgId": "9e49",
"endIPAddress": "string",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"ipVersion": "string",
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
HATEOAS of the entity
A human-friendly description.
External entity Id on the provider side.
Start IP address of the range.
The id of the organization this entity belongs to.
End IP address of the range.
A set of tag keys and optional values that were set on this resource instance.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
IP address version: IPv4 or IPv6. Default: IPv4.
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
Date when the entity was last updated. The date is ISO 8601 and UTC.
State object representing a query result of network IP range.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"startIPAddress": "string",
"orgId": "9e49",
"endIPAddress": "string",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"ipVersion": "string",
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Specification for creating or updating a NetworkIPRange
{
"ipVersion": "string",
"fabricNetworkId": "string",
"name": "string",
"description": "string",
"startIPAddress": "string",
"endIPAddress": "string",
"tags": [
{
"value": "string",
"key": "string"
}
]
}
IP address version: IPv4 or IPv6. Default: IPv4.
The Id of the parent fabric network.
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Start IP address of the range.
End IP address of the range.
A set of tag keys and optional values that were set on this resource instance.
Represents a network interface.
HATEOAS links:
cloud-accounts - array[CloudAccount] - List of cloud accounts where this network domain exists.
security-groups - array[SecurityGroup] - List of security groups for this network interface.
self - NetworkInterface - Self link to this network interface
{
"owner": "[email protected]",
"addresses": [
"string"
],
"externalRegionId": "ap-northeast-2",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"deviceIndex": 1,
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
A list of IP addresses allocated or in use by this network interface.
HATEOAS of the entity
The external regionId of the network interface.
A human-friendly description.
External entity Id on the provider side.
The device index of this network interface.
The id of the organization this entity belongs to.
A set of tag keys and optional values that were set on this network interface.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Set of ids of the cloud accounts this entity belongs to.
Additional properties that may be used to extend the base type.
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
Date when the entity was last updated. The date is ISO 8601 and UTC.
Specification for attaching nic to machine
{
"addresses": [
"string"
],
"securityGroupIds": [
"string"
],
"name": "string",
"description": "string",
"networkId": "dcd9",
"deviceIndex": 1
}
A list of IP addresses allocated or in use by this network interface.
Additional properties that may be used to extend the base type.
A list of security group ids which this network interface will be assigned to.
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Id of the network instance that this network interface plugs into.
The device index of this network interface.
Represents a network Profile.
HATEOAS links:
fabric-networks - array[FabricNetwork] - Fabric networks defined in this profile.
security-groups - array[SecurityGroup] - List of security groups for this profile.
network-domains - array[NetworkDomain] - List of network domains for this profile.
isolated-external-fabric-networks - array[FabricNetwork] - Isolated external fabric networks in this profile.
self - NetowrkProfile - Self link to this network profile
{
"owner": "[email protected]",
"externalRegionId": "us-east-1",
"description": "my-description",
"isolationNetworkDomainCIDR": "string",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"name": "my-name",
"id": "9e49",
"isolationType": "string",
"isolatedNetworkCIDRPrefix": "integer",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
HATEOAS of the entity
The id of the region for which this profile is defined
A human-friendly description.
CIDR of the isolation network domain.
The id of the organization this entity belongs to.
A set of tag keys and optional values that were set on this Network Profile.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Additional properties that may be used to extend the Network Profile object that is produced from this specification. For isolationType security group, datastoreId identifies the Compute Resource Edge datastore. computeCluster and resourcePoolId identify the Compute Resource Edge cluster. For isolationType subnet, distributedLogicalRouterStateLink identifies the on-demand network distributed local router. onDemandNetworkIPAssignmentType identifies the on-demand network IP range assignment type static, dynamic, or mixed.
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
Specifies the isolation type e.g. none, subnet or security group
The CIDR prefix length to be used for the isolated networks that are created with the network profile.
Date when the entity was last updated. The date is ISO 8601 and UTC.
State object representing a query result of network profiles.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"externalRegionId": "us-east-1",
"description": "my-description",
"isolationNetworkDomainCIDR": "string",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"name": "my-name",
"id": "9e49",
"isolationType": "string",
"isolatedNetworkCIDRPrefix": "integer",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
{
"description": "string",
"isolationNetworkDomainCIDR": "10.10.10.0/24",
"isolationNetworkDomainId": "1234",
"tags": [
{
"value": "string",
"key": "string"
}
],
"fabricNetworkIds": [
"string"
],
"regionId": "9e49",
"securityGroupIds": [
"string"
],
"name": "string",
"isolationExternalFabricNetworkId": "1234",
"isolationType": "SUBNET",
"isolatedNetworkCIDRPrefix": 24,
"loadBalancerIds": [
"string"
]
}
A human-friendly description.
CIDR of the isolation network domain.
The Id of the network domain used for creating isolated networks.
A set of tag keys and optional values that should be set on any resource that is produced from this specification.
A list of fabric network Ids which are assigned to the network profile.
Additional properties that may be used to extend the Network Profile object that is produced from this specification. For isolationType security group, datastoreId identifies the Compute Resource Edge datastore. computeCluster and resourcePoolId identify the Compute Resource Edge cluster. For isolationType subnet, distributedLogicalRouterStateLink identifies the on-demand network distributed local router. onDemandNetworkIPAssignmentType identifies the on-demand network IP range assignment type static, dynamic, or mixed.
The Id of the region for which this profile is created
A list of security group Ids which are assigned to the network profile.
A human-friendly name used as an identifier in APIs that support this option.
The Id of the fabric network used for outbound access.
Specifies the isolation type e.g. none, subnet or security group
The CIDR prefix length to be used for the isolated networks that are created with the network profile.
A list of load balancers which are assigned to the network profile.
State object representing a query result of networks.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"externalZoneId": "us-east-1a",
"externalRegionId": "us-east-1",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"deploymentId": "123e4567-e89b-12d3-a456-426655440000",
"name": "my-name",
"cidr": "10.10.0.0/16",
"id": "9e49",
"projectId": "9e49",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Specification for a cloud network
{
"deploymentId": "123e4567-e89b-12d3-a456-426655440000",
"outboundAccess": true,
"name": "string",
"description": "string",
"projectId": "e058",
"constraints": [
{
"expression": "ha:strong",
"mandatory": "boolean"
}
],
"tags": [
{
"value": "string",
"key": "string"
}
]
}
Additional custom properties that may be used to extend the network.
The id of the deployment that is associated with this resource
Flag to indicate if the network needs to have outbound access or not. Default is true. This field will be ignored if there is proper input for networkType customProperty
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
The id of the project the current user belongs to.
Constraints that are used to drive placement policies for the network that is produced from this specification, related with the network profile. Constraint expressions are matched against tags on existing placement targets.
A set of tag keys and optional values that should be set on any resource that is produced from this specification.
Projects link users and cloud zones, thus controlling who can use what cloud resources.
HATEOAS links:
self - Project - Self link to this project
{
"owner": "[email protected]",
"operationTimeout": "integer",
"description": "my-description",
"zones": [
{
"memoryLimitMB": 2048,
"zoneId": "77ee1",
"maxNumberInstances": 50,
"priority": 1
}
],
"orgId": "9e49",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"viewers": [
{
"email": "[email protected]"
}
],
"machineNamingTemplate": "${project.name}-test-${####}",
"sharedResources": "boolean",
"members": [
{
"email": "[email protected]"
}
],
"name": "my-name",
"id": "9e49",
"administrators": [
{
"email": "[email protected]"
}
],
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
HATEOAS of the entity
The timeout that should be used for Blueprint operations and Provisioning tasks. The timeout is in seconds
A human-friendly description.
List of Cloud Zones assigned to this project. You can limit deployment to a single region or allow multi-region placement by adding more than one cloud zone to a project. A cloud zone lists available resources. Use tags on resources to control workload placement.
List of storage, network and extensibility constraints to be applied when provisioning through this project.
The id of the organization this entity belongs to.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
The naming template to be used for machines provisioned in this project
Specifies whether the resources in this projects are shared or not.
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
List of administrator users associated with the project. Only administrators can manage project's configuration.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Represents the resource metadata associated with a project
{
"tags": [
{
"value": "string",
"key": "string"
}
]
}
A list of keys and optional values to be applied to compute resources provisioned in a project
Specification for resource metadata associated with a project
{
"tags": [
{
"value": "string",
"key": "string"
}
]
}
A list of keys and optional values to be applied to compute resources provisioned in a project
State object representing a query result of projects.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"operationTimeout": "integer",
"description": "my-description",
"zones": [
{
"memoryLimitMB": 2048,
"zoneId": "77ee1",
"maxNumberInstances": 50,
"priority": 1
}
],
"orgId": "9e49",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"viewers": [
{
"email": "[email protected]"
}
],
"machineNamingTemplate": "${project.name}-test-${####}",
"sharedResources": "boolean",
"members": [
{
"email": "[email protected]"
}
],
"name": "my-name",
"id": "9e49",
"administrators": [
{
"email": "[email protected]"
}
],
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Represents a specification for a project.
{
"viewers": [
{
"email": "[email protected]"
}
],
"machineNamingTemplate": "${project.name}-test-${####}",
"sharedResources": true,
"operationTimeout": 30,
"members": [
{
"email": "[email protected]"
}
],
"zoneAssignmentConfigurations": [
{
"memoryLimitMB": 2048,
"zoneId": "77ee1",
"maxNumberInstances": 50,
"priority": 1
}
],
"name": "string",
"description": "string",
"administrators": [
{
"email": "[email protected]"
}
]
}
The naming template to be used for machines provisioned in this project
Specifies whether the resources in this projects are shared or not. If not set default will be used.
The timeout that should be used for Blueprint operations and Provisioning tasks. The timeout is in seconds
List of configurations for zone assignment to a project.
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
List of storage, network and extensibility constraints to be applied when provisioning through this project.
List of administrator users associated with the project. Only administrators can manage project's configuration.
State object representing a region in a cloud account.
HATEOAS links:
cloud-account - CloudAccount - Cloud account for the region.self - Region - Self link to this region
{
"owner": "[email protected]",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"externalRegionId": "us-west",
"cloudAccountId": "9e49",
"name": "us-west",
"id": "9e49",
"orgId": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
HATEOAS of the entity
Unique identifier of region on the provider side.
The id of the cloud account this region belongs to.
Name of region on the provider side. In vSphere, the name of the region is different from its id.
The id of this resource instance
The id of the organization this entity belongs to.
Date when the entity was last updated. The date is ISO 8601 and UTC.
State object representing a query result of regions.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"externalRegionId": "us-west",
"cloudAccountId": "9e49",
"name": "us-west",
"id": "9e49",
"orgId": "9e49",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Represents a specification for machine's remote access settings.
{
"password": "string",
"sshKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCu74dLkAGGYIgNuszEAM0HaS2Y6boTPw+HqsFmtPSOpxPQoosws/OWGZlW1uue6Y4lIvdRqZOaLK+2di5512etY67ZwFHc5h1kx4az433DsnoZhIzXEKKI+EXfH/w72CIyG/uVhIzmA4FvRVQKXinE1vaVen6v1CBQEZibx9RXrVRP1VRibsKFRXYxywNEl1VtPK7KaxCEYO9IXi4SKVulSAhOVequwjlo5E8bKNT61/g/YyMvwCbaTTPPeCpS/7i+JHYY3QZ8fQY/Syn+bOFpKCCHl+7VpsL8gjWe6fI4bUp6KUiW7ZkQpL/47rxawKnRMKKEU9P0ICp3RRB39lXT",
"keyPair": "string",
"authentication": "publicPrivateKey",
"username": "string"
}
Remote access password for the Azure machine.
In key pair authentication, the public key on the provisioned machine. Users are expected to log in with their private key and a default username from the cloud provider. An AWS Ubuntu image comes with default user ubuntu, and Azure comes with default user azureuser. To log in by SSH: ssh -i <private-key-path> [email protected]
ssh -i <private-key-path> [email protected]
Key Pair Name.
One of four authentication types. generatedPublicPrivateKey
: The provisioned machine generates the public/private key pair and enables SSH to use them without user input. publicPrivateKey
: The user enters the private key in the SSH command. See remoteAccess.sshKey. usernamePassword
: The user enters a username and password for remote access. keyPairName
: The user enters an already existing keyPair name. See remoteAccess.keyPair
Remote access username for the Azure machine.
An object used to track long-running operations.
{
"name": "Power-off",
"progress": 90,
"resources": [
"string"
],
"id": "we655aew4e8e",
"message": "In Progress",
"status": "FINISHED",
"selfLink": "/.../request-tracker/we655aew4e8e"
}
Name of the operation.
Progress of the request as percentage.
Collection of resources.
ID of this request.
Status message of the request.
Status of the request.
Self link of this request.
State object representing a query result of request tracker objects.
{
"numberOfElements": 1,
"content": [
{
"name": "Power-off",
"progress": 90,
"resources": [
"string"
],
"id": "we655aew4e8e",
"message": "In Progress",
"status": "FINISHED",
"selfLink": "/.../request-tracker/we655aew4e8e"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Load balancer route configuration.
{
"protocol": "TCP, UDP",
"port": "80",
"memberPort": "80",
"memberProtocol": "TCP, UDP",
"healthCheckConfiguration": {
"protocol": "HTTP, HTTPS",
"port": "80",
"timeoutSeconds": 5,
"unhealthyThreshold": 5,
"healthyThreshold": 2,
"urlPath": "/index.html",
"intervalSeconds": 60
}
}
The protocol of the incoming load balancer requests.
Port which the load balancer is listening to.
Member port where the traffic is routed to.
The protocol of the member traffic.
A rule used in a security group.
{
"protocol": "ANY, TCP, UDP",
"access": "Allow",
"service": "HTTPS, SSH",
"ipRangeCidr": "66.170.99.2/32",
"name": "5756f7e2",
"ports": "443, 1-655535",
"direction": "Outbound"
}
Protocol the security rule applies to.
Type of access (allow or deny) for the security rule. Traffic that does not match any rules will be denied.
Service defined by the provider (such as: SSH, HTTPS). Either service or protocol have to be specified.
IP address(es) in CIDR format which the security rule applies to.
Name of security rule.
Ports the security rule applies to.
Direction of the security rule (inbound or outboud).
State object representing a security group.
HATEOAS links:
cloud-accounts - array[CloudAccount] - List of cloud accounts where this security group exists.
self - SecurityGroup - Self link to this security group
{
"owner": "[email protected]",
"externalRegionId": "ap-northeast-2",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"rules": [
{
"protocol": "ANY, TCP, UDP",
"access": "Allow",
"service": "HTTPS, SSH",
"ipRangeCidr": "66.170.99.2/32",
"name": "5756f7e2",
"ports": "443, 1-655535",
"direction": "Outbound"
}
],
"orgId": "9e49",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
HATEOAS of the entity
The external regionId of the security group.
A human-friendly description.
External entity Id on the provider side.
The id of the organization this entity belongs to.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Set of ids of the cloud accounts this entity belongs to.
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
Date when the entity was last updated. The date is ISO 8601 and UTC.
State object representing a query result of security groups.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"externalRegionId": "ap-northeast-2",
"description": "my-description",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"rules": [
{
"protocol": "ANY, TCP, UDP",
"access": "Allow",
"service": "HTTPS, SSH",
"ipRangeCidr": "66.170.99.2/32",
"name": "5756f7e2",
"ports": "443, 1-655535",
"direction": "Outbound"
}
],
"orgId": "9e49",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"cloudAccountIds": [
"string"
],
"name": "my-name",
"id": "9e49",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Represents a machine snapshot
{
"owner": "[email protected]",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"name": "my-name",
"description": "my-description",
"id": "9e49",
"orgId": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
The id of this resource instance
The id of the organization this entity belongs to.
Date when the entity was last updated. The date is ISO 8601 and UTC.
{
"owner": "[email protected]",
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"snapshotMemory": "boolean",
"name": "my-name",
"description": "my-description",
"id": "9e49",
"orgId": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Captures the full state of a running virtual machine, including the memory.
Additional custom properties that may be used to extend the snapshot.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
The id of this resource instance
The id of the organization this entity belongs to.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Represents a structure that holds details of storage profile linked to a cloud zone / region.HATEOAS links:
region - Region - Region for the profile.
self - StorageProfile - Self link to this storage profile.
datastore - FabricVsphereDatastore - Datastore of this storage profile.
storage-policy - FabricVsphereStoragePolicy - vSphere storage policy for this profile.
storage-account - FabricAzureStorageAccount - Azure storage account for this profile.
{
"owner": "[email protected]",
"supportsEncryption": "boolean",
"externalRegionId": "us-east-1",
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"name": "my-name",
"id": "9e49",
"defaultItem": "boolean",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
HATEOAS of the entity
Indicates whether this storage profile supports encryption or not.
The id of the region for which this profile is defined
A human-friendly description.
The id of the organization this entity belongs to.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
Map of storage properties that are to be applied on disk while provisioning.
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
Indicates if a storage profile is default profile or not.
Date when the entity was last updated. The date is ISO 8601 and UTC.
State object representing a query result of Aws storage profiles.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"deviceType": "ebs / instance-store",
"volumeType": "gp2 / io1 / sc1 / st1 / standard",
"supportsEncryption": "boolean",
"externalRegionId": "us-east-1",
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"name": "my-name",
"iops": "2000",
"id": "9e49",
"defaultItem": "boolean",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Represents a specification of AWS storage profile.
{
"deviceType": "ebs / instance-store",
"volumeType": "gp2 / io1 / sc1 / st1 / standard",
"supportsEncryption": "boolean",
"regionId": "31186",
"name": "string",
"iops": "2000",
"description": "string",
"defaultItem": true,
"tags": [
{
"value": "string",
"key": "string"
}
]
}
Indicates the type of storage.
Indicates the type of volume associated with type of storage.
Indicates whether this storage profile supports encryption or not.
A link to the region that is associated with the storage profile.
A human-friendly name used as an identifier in APIs that support this option.
Indicates maximum I/O operations per second in range(1-20,000).
A human-friendly description.
Indicates if a storage profile is default or not.
State object representing a query result of Azure storage profiles.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"supportsEncryption": "boolean",
"externalRegionId": "uswest",
"description": "my-description",
"dataDiskCaching": "None / ReadOnly / ReadWrite",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"name": "my-name",
"id": "9e49",
"defaultItem": "boolean",
"diskType": "Standard_LRS / Premium_LRS",
"osDiskCaching": "None / ReadOnly / ReadWrite",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Represents a specification of Azure storage profile.
{
"storageAccountId": "aaa82",
"supportsEncryption": "boolean",
"regionId": "31186",
"name": "string",
"description": "string",
"defaultItem": true,
"diskType": "Standard_LRS / Premium_LRS",
"dataDiskCaching": "None / ReadOnly / ReadWrite",
"osDiskCaching": "None / ReadOnly / ReadWrite",
"tags": [
{
"value": "string",
"key": "string"
}
]
}
Id of a storage account where in the disk is placed.
Indicates whether this storage policy should support encryption or not.
The If of the region that is associated with the storage profile.
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Indicates if a storage policy contains default storage properties.
Indicates the performance tier for the storage type. Premium disks are SSD backed and Standard disks are HDD backed.
Indicates the caching mechanism for additional disk.
Indicates the caching mechanism for OS disk. Default policy for OS disks is Read/Write.
A set of tag keys and optional values for a storage policy which define set of specifications for creating a disk.
State object representing a query result of storage profiles.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"supportsEncryption": "boolean",
"externalRegionId": "us-east-1",
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"name": "my-name",
"id": "9e49",
"defaultItem": "boolean",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Represents a specification of generic storage profile.
{
"supportsEncryption": "boolean",
"regionId": "31186",
"name": "string",
"description": "string",
"defaultItem": "boolean",
"tags": [
{
"value": "string",
"key": "string"
}
]
}
Map of storage properties that are to be applied on disk while provisioning.
Indicates whether this storage profile supports encryption or not.
Map of storage placements to know where the disk is provisioned.
The Id of the region that is associated with the storage profile.
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Indicates if a storage profile is a default profile.
State object representing a query result of vShpere storage profiles.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"supportsEncryption": "boolean",
"externalRegionId": "Datacenter:datacenter-2",
"sharesLevel": "low / normal / high / custom",
"description": "my-description",
"diskMode": "undefined / independent-persistent / independent-nonpersistent",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"shares": "2000",
"createdAt": "2012-09-27",
"provisioningType": "thin / thick / eagerZeroedThick",
"limitIops": "1000",
"name": "my-name",
"id": "9e49",
"defaultItem": "boolean",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Represents a specification of vSphere storage profile.
{
"supportsEncryption": "boolean",
"sharesLevel": "low / normal / high / custom",
"description": "string",
"diskMode": "undefined / independent-persistent / independent-nonpersistent",
"storagePolicyId": "6b59743af31d",
"tags": [
{
"value": "string",
"key": "string"
}
],
"shares": "2000",
"provisioningType": "thin / thick / eagerZeroedThick",
"regionId": "31186",
"limitIops": "1000",
"name": "string",
"defaultItem": true,
"datastoreId": "08d28"
}
Indicates whether this storage profile supports encryption or not.
Shares are specified as High, Normal, Low or Custom and these values specify share values with a 4:2:1 ratio, respectively.
A human-friendly description.
Type of mode for the disk
Id of the vSphere Storage Policy to be applied.
A specific number of shares assigned to each virtual machine.
Type of provisioning policy for the disk.
The Id of the region that is associated with the storage profile.
The upper bound for the I/O operations per second allocated for each virtual disk.
A human-friendly name used as an identifier in APIs that support this option.
Indicates if a storage profile acts as a default storage profile for a disk.
Id of the vSphere Datastore for placing disk and VM.
{
"value": "string",
"key": "string"
}
Tag's value.
Tag's key.
State object representing a query result of tags.
{
"numberOfElements": 1,
"content": [
{
"value": "string",
"key": "string"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
{
"createDefaultZones": true,
"name": "string",
"description": "string",
"regionIds": [
"string"
],
"tags": [
{
"value": "string",
"key": "string"
}
]
}
Create default cloud zones for the enabled regions.
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
A set of Region names to enable provisioning on.
{
"createDefaultZones": true,
"name": "string",
"description": "string",
"regionIds": [
"string"
],
"tags": [
{
"value": "string",
"key": "string"
}
]
}
Create default cloud zones for the enabled regions.
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
A set of Region names to enable provisioning on.
{
"createDefaultZones": true,
"name": "string",
"description": "string",
"regionIds": [
"string"
],
"tags": [
{
"value": "string",
"key": "string"
}
]
}
Create default cloud zones for the enabled regions.
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
A set of Region names to enable provisioning on.
{
"createDefaultZones": true,
"associatedCloudAccountIds": [
"string"
],
"name": "string",
"description": "string",
"regionIds": [
"string"
],
"tags": [
{
"value": "string",
"key": "string"
}
]
}
Create default cloud zones for the enabled regions.
Cloud accounts to link with this cloud account
Additional custom properties that may be used to extend the Cloud Account.
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
A set of Region names to enable provisioning on.
{
"name": "string",
"description": "string",
"tags": [
{
"value": "string",
"key": "string"
}
]
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
{
"createDefaultZones": true,
"name": "string",
"description": "string",
"regionIds": [
"string"
],
"tags": [
{
"value": "string",
"key": "string"
}
]
}
Create default cloud zones for the enabled regions.
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
A set of Region names to enable provisioning on.
{
"createDefaultZones": true,
"name": "string",
"description": "string",
"regionIds": [
"string"
],
"tags": [
{
"value": "string",
"key": "string"
}
]
}
Create default cloud zones for the enabled regions.
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
A set of Region names to enable provisioning on.
{
"name": "string",
"description": "string"
}
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Map between global fabric flavor keys
{
"name": "string",
"description": "string"
}
Image mapping defined for the corresponding region.
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
{
"description": "string",
"tags": [
{
"value": "string",
"key": "string"
}
]
}
Describes machine within the scope of your organization and is not propagated to the cloud
A set of tag keys and optional values that should be set on any resource that is produced from this specification.
The email of the user.
{
"volumeTypes": [
"string"
]
}
volumeTypes
Defines a structure that holds storage profile details defined for vSphere for a specific region.HATEOAS links:
datastore - FabricVsphereDatastore - Datastore for this storage profile.
storage-policy - FabricVsphereStoragePolicy - vSphere storage policy for this storage profile.
region - Region - Region for the profile.
self - VsphereStorageProfile - Self link to this vSphere storage profile.
{
"owner": "[email protected]",
"supportsEncryption": "boolean",
"externalRegionId": "Datacenter:datacenter-2",
"sharesLevel": "low / normal / high / custom",
"description": "my-description",
"diskMode": "undefined / independent-persistent / independent-nonpersistent",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"shares": "2000",
"createdAt": "2012-09-27",
"provisioningType": "thin / thick / eagerZeroedThick",
"limitIops": "1000",
"name": "my-name",
"id": "9e49",
"defaultItem": "boolean",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
HATEOAS of the entity
Indicates whether this storage profile should support encryption or not.
The id of the region for which this profile is defined
Shares level are specified as High, Normal, Low or Custom.
A human-friendly description.
Type of mode for the disk
The id of the organization this entity belongs to.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
A specific number of shares assigned to each virtual machine.
Date when the entity was created. The date is in ISO 8601 and UTC.
Type of format for the disk.
The upper bound for the I/O operations per second allocated for each disk.
A human-friendly name used as an identifier in APIs that support this option.
The id of this resource instance
Indicates if a storage profile contains default storage properties.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Description of a compute placement zone. This can be used to specify a subset of compute resources within a region where machines can be placed.
HATEOAS links:
region - Region - Region for the zone.
computes - Computes - Computes for the zone.
cloud-account - CloudAccount - The cloud account that the zone belongs to.
self - Zone - Self link to this zone
{
"owner": "[email protected]",
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"folder": "test-folder",
"tagsToMatch": [
{
"value": "string",
"key": "string"
}
],
"name": "my-name",
"placementPolicy": "DEFAULT, SPREAD, BINPACK",
"id": "9e49",
"updatedAt": "2012-09-27"
}
Email of the user that owns the entity.
HATEOAS of the entity
A human-friendly description.
The id of the organization this entity belongs to.
This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.
Date when the entity was created. The date is in ISO 8601 and UTC.
A list of key value pair of properties that will be used
The folder relative path to the datacenter where resources are deployed to. (only applicable for vSphere cloud zones)
A set of tag keys and optional values for compute resource filtering.
A human-friendly name used as an identifier in APIs that support this option.
The placement policy for the zone.
The id of this resource instance
Date when the entity was last updated. The date is ISO 8601 and UTC.
A zone assignment configuration
{
"memoryLimitMB": 2048,
"zoneId": "77ee1",
"maxNumberInstances": 50,
"priority": 1
}
The maximum amount of memory that can be used by this cloud zone. Default is 0 (unlimited memory). Please note that this feature works only for vSphere cloud zones.
The Cloud Zone Id
The maximum number of instances that can be provisioned in this cloud zone. Default is 0 (unlimited instances).
The priority of this zone in the current project. Lower numbers mean higher priority. Default is 0 (highest)
State object representing a query result of Zones.
{
"numberOfElements": 1,
"content": [
{
"owner": "[email protected]",
"description": "my-description",
"orgId": "9e49",
"tags": [
{
"value": "string",
"key": "string"
}
],
"organizationId": "deprecated",
"createdAt": "2012-09-27",
"folder": "test-folder",
"tagsToMatch": [
{
"value": "string",
"key": "string"
}
],
"name": "my-name",
"placementPolicy": "DEFAULT, SPREAD, BINPACK",
"id": "9e49",
"updatedAt": "2012-09-27"
}
],
"totalElements": 1
}
Number of elements in the current page
Total number of elements. In some cases the field may not be populated
Specification for a zone.
{
"folder": "test-folder",
"regionId": "9e49",
"tagsToMatch": [
{
"value": "string",
"key": "string"
}
],
"name": "string",
"description": "string",
"placementPolicy": "DEFAULT",
"tags": [
{
"value": "string",
"key": "string"
}
]
}
A list of key value pair of properties that will be used
The folder relative path to the datacenter where resources are deployed to. (only applicable for vSphere cloud zones)
The id of the region for which this profile is created
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
Placement policy for the zone. One of DEFAULT, SPREAD or BINPACK.
A set of tag keys and optional values that are effectively applied to all compute resources in this zone, but only in the context of this zone.