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

PropertyTypeDescriptionRequired
Show all NFS disks
nfsShowAll		boolean

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
Disable NFS disk monitoring
disableNfsDiskMonitoring		boolean

Deactivate NFS monitoring on all supported systems

required
Exclude disks
exclusions		DiskComplex[]

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.

⚠️ Filtering is done before resolving symbolic links.

required
The DiskComplex object
PropertyTypeDescriptionRequired
Operating system
os		enum
  • OS_TYPE_UNKNOWN
  • OS_TYPE_AIX
  • OS_TYPE_DARWIN
  • OS_TYPE_HPUX
  • OS_TYPE_LINUX
  • OS_TYPE_SOLARIS
  • OS_TYPE_WINDOWS
  • OS_TYPE_ZOS
required
Disk or mount point path
mountpoint		text

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

⚠️ Filtering is done before resolving symbolic links.

optional
File system type
filesystem		text

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

  • ext4
  • ext3
  • btrfs
  • ext*

⚠️ Starting from OneAgent 1.299+ file system types are not case sensitive!

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

optional