---
title: "Operate on a cluster system"
method: PATCH
path: "/clusters/{ClusterName}/systems/{SystemName}"
tags: ["Systems"]
---

# Operate on a cluster system

`PATCH /clusters/{ClusterName}/systems/{SystemName}`

## Request

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

Perform operation include Freeze Unfreeze Load.

## Path parameters

- `ClusterName` string, required
- `SystemName` string, required

## Request body

- SystemV2v0
  - `AgentsStopped` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `AvailableCapacity` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `Capacity` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ConfigBlockCount` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ConfigCheckSum` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ConfigDiskState` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ConfigFile` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ConfigInfoCnt` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ConfigModDate` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `CPUThresholdLevel` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `CPUUsage` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `CPUUsageMonitoring` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `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
  - `CurrentLimits` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `DiskHbStatus` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `DynamicLoad` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `EngineRestarted` 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
  - `ExcludedDisks` ExcludedDisk[]: List of all excluded disks
    - `DiskId` string: Unique disk Identifier
    - `Name` string: Name of excluded disk
    - `Links` Link[]
      - `rel` string
      - `href` string, uri
    - `Operations` Operation[]: Operations supported on excluded disk
      - `Name` string: Operation name
      - `href` string, uri: Link to the operation
  - `FencingWeight` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `Frozen` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `FrozenState` Systemfreeze
    - `Evacuate` boolean: Indicates evacuate
    - `Frozen` boolean: Indicates freeze or unfreeze
    - `Persistent` boolean: Indicates persistent or temporary freeze
  - `GUIIPAddr` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `HostAvailableForecast` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `HostMonitor` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `HostUtilization` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `LicenseType` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `Limits` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `LinkHbStatus` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `LLTNodeId` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `LoadTimeCounter` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `LoadTimeThreshold` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `LoadWarningLevel` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `MemThresholdLevel` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `MeterRecord` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `NoAutoDisable` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `NodeId` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `OnGrpCnt` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ReservedCapacity` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `ShutdownTimeout` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `Site` 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
  - `SupportedProtocol` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `SwapThresholdLevel` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `SysInfo` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `SysName` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `SysState` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `SystemLocation` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `SystemOwner` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `SystemRecipients` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `TFrozen` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `TRSE` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `UpDownState` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `UserInt` Attribute
    - `Value` unknown, required
    - `Type` 'scalar' | 'vector' | 'keylist' | 'associate': Type of the attribute
    - `KeyAttribute` boolean: Describes whether it is a key attribute or Not
  - `UserStr` 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

## Response `200`

The request has succeeded.

- Response
  - `detail` string: Error details.
  - `status` integer: http code

## 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)