{
"description": "Used to provide the deployment specification for the service.",
"extends": {
"$ref": "ManagedResource
},
"id": "ServiceDeployment",
"module_id": "ServiceInsertionCommonTypes",
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"title": "Generation of this resource config",
"type": "int"
},
"_schema": {
"readonly": true,
"title": "Schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true,
"title": "Link to this resource"
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"clustered_deployment_count": {
"default": 1,
"description": "Number of instances in case of clustered deployment.",
"maximum": 10,
"minimum": 1,
"readonly": false,
"required": false,
"title": "Clustered Deployment Count",
"type": "integer"
},
"deployed_to": {
"description": "List of resource references where service instance be deployed. Ex. Tier 0 Logical Router in case of N-S ServiceInsertion. Service Attachment in case of E-W ServiceInsertion.",
"items": {
"$ref": "ResourceReference
},
"maxItems": 128,
"minItems": 1,
"readonly": false,
"required": false,
"title": "Deployed-to object list",
"type": "array"
},
"deployment_mode": {
"default": "STAND_ALONE",
"description": "Mode of deployment. Currently, only stand alone deployment is supported. It is a single VM deployed through this deployment spec. In future, HA configurations will be supported here.",
"enum": [
"STAND_ALONE",
"ACTIVE_STANDBY"
],
"readonly": false,
"required": false,
"title": "Deployment Mode",
"type": "string"
},
"deployment_spec_name": {
"description": "Name of the deployment spec to be used for deployment, which specifies the OVF provided by the partner and the form factor.",
"readonly": false,
"required": true,
"title": "Deployment Spec Name",
"type": "string"
},
"deployment_type": {
"default": "CLUSTERED",
"description": "Specifies whether the service VM should be deployed on each host such that it provides partner service locally on the host, or whether the service VMs can be deployed as a cluster. If deployment_type is CLUSTERED, then the clustered_deployment_count should be provided.",
"enum": [
"HOSTLOCAL",
"CLUSTERED"
],
"readonly": false,
"required": false,
"title": "Deployment Type",
"type": "string"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"id": {
"can_sort": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"instance_deployment_template": {
"$ref": "DeploymentTemplate,
"description": "The deployment template to be used during the deployment to provide customized attributes to the service VM.",
"readonly": false,
"required": true,
"title": "Instance Deployment Template"
},
"perimeter": {
"default": "HOST",
"description": "This indicates the deployment perimeter, such as a VC cluster or a host.",
"enum": [
"CLUSTER",
"HOST"
],
"readonly": false,
"required": false,
"title": "Deployment perimeter",
"type": "string"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"service_deployment_config": {
"$ref": "ServiceDeploymentConfig,
"description": "Deployment Config contains the deployment specification, such as the storage and network to be used along with the cluster where the service VM can be deployed.",
"readonly": false,
"required": true,
"title": "Service Deployment Config"
},
"service_id": {
"description": "The Service to which the service deployment is associated.",
"readonly": true,
"required": false,
"title": "Service Id",
"type": "string"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
}
},
"title": "Deployment details of a Service",
"type": "object"
}