Snapservice.Sites.Service

Snapservice.Sites.Service
Snapservice.Sites.Service

The Snapservice.Sites.Service schema contains details of the service.

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "id": "string",
    "type": "string",
    "name": "string",
    "url": "string",
    "connection_state": {
        "connection_status": "string",
        "errors": [
            {
                "messages": [
                    {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi.Std.NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    }
                ]
            }
        ],
        "warnings": [
            {
                "messages": [
                    {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi.Std.NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    }
                ]
            }
        ]
    }
}
string
id
Required

ID of service.

This property was added in vSphere API 9.0.0.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.snapservice.site. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.snapservice.site.

string
type
Required

Type of service.

Possible values:

  • SS: Snapshot Service.
  • SRM: Site Recovery Manager.
  • HMS: HBR Manager Service.

For more information see: Snapservice.Sites.ServiceType.

This property was added in vSphere API 9.0.0.0.

string
name
Required

Name of service.

This property was added in vSphere API 9.0.0.0.

string As uri As uri
url
Required

URL of service;

This property was added in vSphere API 9.0.0.0.

connection_state
Required

Connection status of service.

This property was added in vSphere API 9.0.0.0.