{
"additionalProperties": false,
"description": "Represents an instance of partner Service and its configuration.",
"extends": {
"$ref": "BasePolicyServiceInstance
},
"id": "PolicyServiceInstance",
"module_id": "PolicyServiceInsertion",
"polymorphic-type-descriptor": {
"type-identifier": "PolicyServiceInstance"
},
"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"
},
"attributes": {
"description": "List of attributes specific to a partner for which the service is created. There attributes are passed on to the partner appliance.",
"items": {
"$ref": "Attribute
},
"maxItems": 128,
"required": true,
"title": "Deployment Template attributes",
"type": "array"
},
"children": {
"description": "subtree for this type within policy tree containing nested elements.",
"items": {
"$ref": "ChildPolicyConfigResource
},
"required": false,
"title": "subtree for this type within policy tree",
"type": "array"
},
"compute_id": {
"description": "Id of the compute(ResourcePool) to which this service needs to be deployed.",
"required": true,
"title": "Id of the compute resource.",
"type": "string"
},
"context_id": {
"description": "UUID of VCenter/Compute Manager as seen on NSX Manager, to which this service needs to be deployed.",
"required": false,
"title": "Id of the compute manager",
"type": "string"
},
"deployment_mode": {
"default": "ACTIVE_STANDBY",
"description": "Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.",
"enum": [
"STAND_ALONE",
"ACTIVE_STANDBY"
],
"readonly": false,
"required": false,
"title": "Deployment Mode",
"type": "string"
},
"deployment_spec_name": {
"description": "Form factor for the deployment of partner service.",
"required": true,
"title": "Name of the Deployment Specification",
"type": "string"
},
"deployment_template_name": {
"description": "Template for the deployment of partnet service.",
"required": true,
"title": "Name of the Deployment Template",
"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"
},
"failure_policy": {
"default": "BLOCK",
"description": "Failure policy for the Service VM. If this values is not provided, it will be defaulted to FAIL_CLOSE.",
"enum": [
"ALLOW",
"BLOCK"
],
"required": false,
"title": "Failure policy for the Service VM",
"type": "string"
},
"id": {
"can_sort": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"marked_for_delete": {
"default": false,
"description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.",
"readonly": true,
"required": false,
"title": "Indicates whether the intent object is marked for deletion",
"type": "boolean"
},
"overridden": {
"default": false,
"description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.",
"readonly": true,
"required": false,
"title": "Indicates whether this object is the overridden intent object",
"type": "boolean"
},
"parent_path": {
"description": "Path of its parent",
"readonly": true,
"required": false,
"title": "Path of its parent",
"type": "string"
},
"partner_service_name": {
"description": "Unique name of Partner Service in the Marketplace",
"required": true,
"title": "Name of Partner Service",
"type": "string"
},
"path": {
"description": "Absolute path of this object",
"readonly": true,
"required": false,
"title": "Absolute path of this object",
"type": "string"
},
"primary_gateway_address": {
"$ref": "IPElement,
"description": "Gateway address for primary management console. If the provided segment already has gateway, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have gateway, this field must be provided.",
"required": false,
"title": "Gateway for primary management console"
},
"primary_interface_mgmt_ip": {
"$ref": "IPElement,
"description": "Management IP Address of primary interface of the Service",
"required": true,
"title": "Management IP Address of primary interface of the Service"
},
"primary_interface_network": {
"description": "Path of the segment to which primary interface of the Service VM needs to be connected",
"required": false,
"title": "Path of the segment to which primary interface of the Service VM needs to be connected",
"type": "string"
},
"primary_portgroup_id": {
"description": "Id of the standard or ditsributed port group for primary management console. Please note that only 1 of the 2 values from 1. primary_interface_network 2. primary_portgroup_id are allowed to be passed. Both can't be passed in the same request.",
"required": false,
"title": "Id of the standard or ditsributed port group for primary management console",
"type": "string"
},
"primary_subnet_mask": {
"$ref": "IPElement,
"description": "Subnet for primary management console IP. If the provided segment already has subnet, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have subnet, this field must be provided.",
"required": false,
"title": "Subnet for primary management console IP"
},
"relative_path": {
"description": "Path relative from its parent",
"readonly": true,
"required": false,
"title": "Relative path of this object",
"type": "string"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"secondary_gateway_address": {
"$ref": "IPElement,
"description": "Gateway address for secondary management console. If the provided segment already has gateway, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have gateway, this field must be provided.",
"required": false,
"title": "Gateway for secondary management console"
},
"secondary_interface_mgmt_ip": {
"$ref": "IPElement,
"description": "Management IP Address of secondary interface of the Service",
"required": false,
"title": "Management IP Address of secondary interface of the Service"
},
"secondary_interface_network": {
"description": "Path of segment to which secondary interface of the Service VM needs to be connected",
"required": false,
"title": "Path of segment to which secondary interface of the Service VM needs to be connected",
"type": "string"
},
"secondary_portgroup_id": {
"description": "Id of the standard or ditsributed port group for secondary management console. Please note that only 1 of the 2 values from 1. secondary_interface_network 2. secondary_portgroup_id are allowed to be passed. Both can't be passed in the same request.",
"required": false,
"title": "Id of the standard or ditsributed port group for secondary management console",
"type": "string"
},
"secondary_subnet_mask": {
"$ref": "IPElement,
"description": "Subnet for secondary management console IP. If the provided segment already has subnet, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have subnet, this field must be provided.",
"required": false,
"title": "Subnet for secondary management console IP"
},
"storage_id": {
"description": "Id of the storage(Datastore). VC moref of Datastore to which this service needs to be deployed.",
"required": true,
"title": "Id of the storage",
"type": "string"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
},
"transport_type": {
"default": "L2_BRIDGE",
"description": "Transport to be used while deploying Service-VM.",
"enum": [
"L2_BRIDGE",
"L3_ROUTED"
],
"readonly": false,
"required": false,
"title": "Transport Type",
"type": "string"
},
"unique_id": {
"description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.",
"readonly": true,
"required": false,
"title": "A unique identifier assigned by the system",
"type": "string"
}
},
"title": "Represents an instance of partner Service and its configuration",
"type": "object"
}