PolicyServiceInstance

Represents an instance of partner Service and its configuration.


Properties

Required Property Name Type Description
optional _create_time integer

Timestamp of resource creation

optional _create_user string

ID of the user who created this resource

optional _last_modified_time integer

Timestamp of last modification

optional _last_modified_user string

ID of the user who last modified this resource

optional _links array of ResourceLink

The server will populate this field when returing the resource. Ignored on PUT and POST.

optional _protection string

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.

optional _revision integer

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.

optional _schema string

Schema for this resource

optional _self SelfResourceLink

Link to this resource

optional _system_owned boolean

Indicates system owned resource

optional attributes array of Attribute

List of attributes specific to a partner for which the service is created. There attributes are passed on to the partner appliance.

optional children array of ChildPolicyConfigResource

subtree for this type within policy tree containing nested elements.

optional compute_id string

Id of the compute(ResourcePool) to which this service needs to be deployed.

optional context_id string

UUID of VCenter/Compute Manager as seen on NSX Manager, to which this service needs to be deployed.

optional deployment_mode string

Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.

optional deployment_spec_name string

Form factor for the deployment of partner service.

optional deployment_template_name string

Template for the deployment of partnet service.

optional description string

Description of this resource

optional display_name string

Defaults to ID if not set

optional failure_policy string

Failure policy for the Service VM. If this values is not provided, it will be defaulted to FAIL_CLOSE.

optional id string

Unique identifier of this resource

optional marked_for_delete boolean

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.

optional parent_path string

Path of its parent

optional partner_service_name string

Unique name of Partner Service in the Marketplace

optional path string

Absolute path of this object

optional primary_gateway_address string

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.

optional primary_interface_mgmt_ip string

Management IP Address of primary interface of the Service

optional primary_interface_network string

Path of the segment to which primary interface of the Service VM needs to be connected

optional primary_portgroup_id string

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.

optional primary_subnet_mask string

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.

optional relative_path string

Path relative from its parent

optional resource_type string

The type of this resource.

optional secondary_gateway_address string

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.

optional secondary_interface_mgmt_ip string

Management IP Address of secondary interface of the Service

optional secondary_interface_network string

Path of segment to which secondary interface of the Service VM needs to be connected

optional secondary_portgroup_id string

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.

optional secondary_subnet_mask string

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.

optional storage_id string

Id of the storage(Datastore). VC moref of Datastore to which this service needs to be deployed.

optional tags array of Tag

Opaque identifiers meaningful to the API user

optional transport_type string

Transport to be used while deploying Service-VM.

JSON Example

{
    "_create_time": 0,
    "_create_user": "string",
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_protection": "string",
    "_revision": 0,
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_system_owned": false,
    "attributes": [
        {
            "attribute_type": "string",
            "display_name": "string",
            "key": "string",
            "read_only": false,
            "value": "string"
        }
    ],
    "children": [
        {
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_protection": "string",
            "_revision": 0,
            "_schema": "string",
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "marked_for_delete": false,
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ]
        }
    ],
    "compute_id": "string",
    "context_id": "string",
    "deployment_mode": "string",
    "deployment_spec_name": "string",
    "deployment_template_name": "string",
    "description": "string",
    "display_name": "string",
    "failure_policy": "string",
    "id": "string",
    "marked_for_delete": false,
    "parent_path": "string",
    "partner_service_name": "string",
    "path": "string",
    "primary_gateway_address": "string",
    "primary_interface_mgmt_ip": "string",
    "primary_interface_network": "string",
    "primary_portgroup_id": "string",
    "primary_subnet_mask": "string",
    "relative_path": "string",
    "resource_type": "string",
    "secondary_gateway_address": "string",
    "secondary_interface_mgmt_ip": "string",
    "secondary_interface_network": "string",
    "secondary_portgroup_id": "string",
    "secondary_subnet_mask": "string",
    "storage_id": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "transport_type": "string"
}
Feedback

Was this page helpful?