| _create_time |
Timestamp of resource creation |
EpochMsTimestamp |
Readonly
Sortable |
| _create_user |
ID of the user who created this resource |
string |
Readonly |
| _last_modified_time |
Timestamp of last modification |
EpochMsTimestamp |
Readonly
Sortable |
| _last_modified_user |
ID of the user who last modified this resource |
string |
Readonly |
| _links |
References related to this resource
The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink |
Readonly |
| _protection |
Indicates protection status of this resource
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.
|
string |
Readonly |
| _revision |
Generation of this resource config
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. |
int |
|
| _schema |
Schema for this resource |
string |
Readonly |
| _self |
Link to this resource |
SelfResourceLink |
Readonly |
| _system_owned |
Indicates system owned resource |
boolean |
Readonly |
| clustered_deployment_count |
Clustered Deployment Count
Number of instances in case of clustered deployment. |
integer |
Minimum: 1
Maximum: 10
Default: "1" |
| deployed_to |
Deployed-to object list
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. |
array of ResourceReference |
Minimum items: 1
Maximum items: 128 |
| deployment_mode |
Deployment Mode
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. |
string |
Enum: STAND_ALONE, ACTIVE_STANDBY
Default: "STAND_ALONE" |
| deployment_spec_name |
Deployment Spec Name
Name of the deployment spec to be used for deployment, which specifies the OVF provided by the partner and the form factor. |
string |
Required |
| deployment_type |
Deployment Type
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. |
string |
Enum: HOSTLOCAL, CLUSTERED
Default: "CLUSTERED" |
| description |
Description of this resource |
string |
Maximum length: 1024
Sortable |
| display_name |
Identifier to use when displaying entity in logs or GUI
Defaults to ID if not set |
string |
Maximum length: 255
Sortable |
| id |
Unique identifier of this resource |
string |
Sortable |
| instance_deployment_template |
Instance Deployment Template
The deployment template to be used during the deployment to provide customized attributes to the service VM. |
DeploymentTemplate |
Required |
| perimeter |
Deployment perimeter
This indicates the deployment perimeter, such as a VC cluster or a host. |
string |
Enum: CLUSTER, HOST
Default: "HOST" |
| resource_type |
Must be set to the value ServiceDeployment |
string |
|
| service_deployment_config |
Service Deployment Config
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. |
ServiceDeploymentConfig |
Required |
| service_id |
Service Id
The Service to which the service deployment is associated. |
string |
Readonly |
| tags |
Opaque identifiers meaningful to the API user |
array of Tag |
Maximum items: 30 |