---
title: "Get cluster info"
method: GET
path: "/clusters/{ClusterName}"
tags: ["Clusters"]
---

# Get cluster info

`GET /clusters/{ClusterName}`

## Request

- Base URL: `https://sort.veritas.com/infoscale/api/2.0`
- URL: `https://sort.veritas.com/infoscale/api/2.0/clusters/{ClusterName}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/veritas/apis/veritas-infoscale-api/docs/clusters/:ClusterName/get.ts> (a function with typed inputs; its response is checked against the schema)

Get details about the cluster.

## Path parameters

- `ClusterName` string, required

## Response `200`

Get the details of the cluster

- ClusterV2v0
  - `AdministratorGroups` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `Administrators` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `AutoClearQ` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `AutoStartTimeout` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `AutoAddSystemToCSG` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `BackupInterval` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `CID` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ClusState` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ClusterAddress` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ClusterLocation` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ClusterName` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ClusterOwner` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ClusterRecipients` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ClusterTime` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ClusterUUID` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `CompareRSM` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ConfigState` 'DUMP' | 'MAKERO_DUMP' | 'MAKERW': Update cluster configuration.
  - `Protocols` ProtocolVersionV2[]: Protocol versions
    - `ProductName` 'cvm' | 'fen' | 'fs' | 'gab' | 'odm' | 'vcs', required: Name of the product whose version is to be upgraded
    - `Version` string: Version to be upgraded in case of VCS product
    - `SupportedVersions` object[]
      - `NodeName` string: Name of the node
      - `Versions` string[]
  - `ConnectorState` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `CounterInterval` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `CounterMissAction` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `CounterMissTolerance` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `CredRenewFrequency` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `CVMNodeStates` object[]: CVM node states
    - `system` string: System name
    - `role` string: Primary/secondary
    - `state` string: CVM node state
    - `errDetails` string: Reason if node is not healthy or transient
  - `DeleteOnlineResource` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `DumpingMembership` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `EngineClass` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `EngineVersion` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `EnableFFDC` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `EnableVMAutoDiscovery` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `EnablePBF` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `EnginePriority` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `EngineShutdown` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `FipsMode` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `GlobalCounter` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `Guests` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `GuestGroups` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `DefaultGuestAccess` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `GroupLimit` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `HacliUserLevel` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `HostAvailableMeters` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `HostMeters` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `IV256List` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `LockMemory` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `LogClusterUUID` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `LogSize` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `MeterControl` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `MeterUnit` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `MeterWeight` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `MixedVersion` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `Notifier` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `OpenVCSCommunicationPort` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `OperatorGroups` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `Operators` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `PanicOnNoMem` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `PreferredFencingPolicy` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `PrintMsg` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ProcessClass` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ProcessPriority` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ProtocolNumber` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ReadOnly` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ResourceLimit` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `SecInfo` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `SecInfo256` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `IV256` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `SecInfoLevel` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `SecureClus` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `SiteAware` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `SourceFile` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `Statistics` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `Stewards` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `SystemRebootAction` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `TypeLimit` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `UseFence` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `UserNames` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `VCSFeatures` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `VCSMode` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `WACPort` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not

## Other responses

- `400`: Bad request
- `401`: The requested operation requires authentication.
- `403`: Forbidden
- `404`: Object that the endpoint is working on is not found.

---

[API](https://skmtc.dev/veritas/apis/veritas-infoscale-api.md) - [All operations](https://skmtc.dev/veritas/apis/veritas-infoscale-api/llms.txt) - [OpenAPI document](https://skmtc.dev/veritas/apis/veritas-infoscale-api/revisions/1e3d3f7145bb?raw)