---
title: "Update a diskgroup"
method: PATCH
path: "/diskgroups/{DiskgroupId}"
tags: ["Diskgroups"]
---

# Update a diskgroup

`PATCH /diskgroups/{DiskgroupId}`

## Request

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

Perform operations like add or remove disks from a diskgroup

## Path parameters

- `DiskgroupId` string, required

## Query parameters

- `nodename` string

## Request body

- DiskgroupDetailV2v0
  - `DiskgroupId` string: Diskgroup identifier
  - `Name` string: Diskgroup name
  - `State` string: State of the diskgroup
  - `FreeSize` string: Available/free size in diskgroup
  - `TotalSize` string: Total size of diskgroup
  - `Tags` TagSchema[]: Tags set on the diskgroup (Prefix TagName field with '!' for remove tag PATCH operation)
    - `TagName` string, required: The tag name to be set (Prefix with '!' for remove tag PATCH operation)
    - `TagValue` string: The tag value to be set
  - `DiskList` object[]: Array of the DA and DM name (Prefix DmName field with '!' for remove disk PATCH operation)
    - `DaId` string, uri: Disk accessname identifier
    - `DmName` string: Disk medianame (Prefix with '!' for remove disk PATCH operation)
  - `Import` object
    - `attributes` ImportAttributes
      - `Fss` boolean: Set fss attribute while importing the diskgroup
      - `Seed` boolean: Set seed attribute while importing the diskgroup
      - `BaseMinor` integer: To assign new reminor numbers to the diskgroup during import
      - `NodeList` object[], required: Array of nodes on which diskgroup is to be imported on.
        - `NodeName` string: Name of Node
      - `Dgtype` 'private' | 'shared', required: Diskgroup type like private, shared
      - `Site` string: To import devices with a specific site name
      - `NewName` string: To rename the diskgroup while importing
      - `ClearHostId` boolean: Clear the existing host ID on all disks in the diskgroup
      - `CloneDiskFlag` boolean: Clear the clone_disk flag while importing the diskgroup
      - `UpdateId` boolean: To generate new identification values for the disks that are being imported for clone disks having ambiguous UDID values
      - `UseCloneDev` boolean: Specify true to import devices that have the clone_disk or udid_mismatch flag set
      - `ClearReserve` boolean: Specify true to clear pre-existing reservations on the disks that comprise the disk group
      - `GroupReserve` string: To specify the I/O fencing key explicitly(fence_key, must be no longer than 7 bytes)
      - `DisksTag` string: Disks that are tagged with a matching tag name are imported into the diskgroup
  - `Version` integer: Disk group version
  - `Flags` string: Space separated flags like FSS, shared, encrypted, imported etc. of diskgroup
  - `AssociatedVolumeCount` integer: Total number of volumes present on diskgroup
  - `AssociatedVolumeList` DgVolumes[]: Names of associated volumes and respective url
    - `VolumeName` string: Associated volume name
    - `VolId` string, uri: Link to the volume
  - `Operations` Operation[]: Operations supported on a particular diskgroup
    - `Name` string: Operation name
    - `href` string, uri: Link to the operation

## Response `200`

The request has succeeded.

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

## Other responses

- `202`: The request has been initiated.
- `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)