• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Disk options

Settings API - Disk options schema table

Disk options (builtin:disk.options)

Disk options settings control the visibility of local disks on your hosts.

Schema IDSchema groupsScope
builtin:disk.options
  • group:preferences
HOST - Host
HOST_GROUP - Host Group
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:disk.options
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:disk.options
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:disk.options

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyLabelTypeDescriptionRequired
nfsShowAllShow all NFS disksboolean

When disabled OneAgent will try to deduplicate some of nfs disks. Disabled by default, applies only to Linux hosts. Requires OneAgent 1.209 or later

required
exclusionsExclude diskslist

OneAgent automatically detects and monitors all your mount points, however you can create exception rules to remove disks from the monitoring list.

Certain filesystems are always excluded as monitoring of them is not useful. For example, autofs, proc, cgroup, tmpfs.

required

Request body objects

The DiskComplex object
PropertyLabelTypeDescriptionRequired
osOperating systemenum-required
mountpointDisk or mount point pathtext

Disk or mount point path field: the path to where the disk to be excluded from monitoring is mounted. Examples:

  • /mnt/my_disk
  • /staff/emp1
  • C:\
  • /staff/*
  • /disk*

⚠️ Mount point paths are case sensitive!

The wildcard in /staff/* means to exclude every child folder of /staff.

The wildcard in /disk* means to exclude every mount point starting with /disk, for example /disk1, /disk99, /diskabc

optional
filesystemFile system typetext

File system type field: the type of the file system to be excluded from monitoring. Examples:

  • ext4
  • ext3
  • btrfs
  • ext*

⚠️ File system types are case sensitive!

The wildcard in the last example means to exclude matching file systems such as types ext4 and ext3

optional