Get Vx Rail Manager

Get Vx Rail Manager

Get a VxRail Manager

Request
URI
GET
https://{api_host}/v1/vxrail-managers/{fqdn}
COPY
Path Parameters
string
fqdn
Required

fqdn

Responses
200

Ok

Returns VxRailManager of type(s) application/json 
{
    "id": "string",
    "fqdn": "string",
    "ipAddress": "string",
    "domain": {
        "id": "string",
        "name": "string",
        "type": "string"
    },
    "vcenter": {
        "id": "string",
        "fqdn": "string",
        "vcInstanceId": "string"
    },
    "cluster": {
        "id": "string",
        "name": "string"
    },
    "name": "string",
    "status": "string",
    "version": "string"
}
string
id
Optional

ID of the VxRailManager

string
fqdn
Optional

FQDN of the VxRailManager

string
ipAddress
Optional

IP address of the VxRailManager

DomainReference
domain
Optional

Represents a domain reference

VcenterReference
vcenter
Optional

Represents a vCenter reference

ClusterReference
cluster
Optional

Represents a reference to the cluster

string
name
Optional

Name of the VxRailManager Appliance VM

string
status
Optional

Operational status of VxRailManager

string
version
Optional

Version of the VxRailManager


404

Resource not found

Returns Error of type(s) application/json 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of ErrorCause
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


500

InternalServerError

Returns Error of type(s) application/json 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of ErrorCause
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


On This Page
Vx Rail Managers Operations
GET
Get Vx Rail Manager
GET
Get Vx Rail Managers