Usage Guidelines

Accompany the base stcli cleaner command with one or more positional arguments, or the optional --help option.

The stcli cleaner command typically runs in the background continuously. cleaner goes into sleep mode when it is not needed and wakes when policy defined conditions are met. These conditions include:

• Number of flushes since the last cleaner run.

• Amount of data written since the last cleaner run.

• Amount of data deleted since the last cleaner run.

• Storage cluster space usage. See capacity status.

Priority levels are:

• Normal Priority. The cleaner generates minimum I/O.

• High Priority. The cleaner I/O is increased.

  If your storage cluster is experiencing ENOSPC condition, the cleaner automatically runs at High Priority.

Priority is determined by:

• Time of Day (TOD) - Default is 6 AM UTC to 6 AM UTC, which disables the TOD-based High Priority cleaner. Use stcli cleaner set-schedule.

• Cluster Space Usage - If the storage cluster reaches an ENOSPC WARN condition, the cleaner increases its intensity by increasing the number of I/O to garbage collect. With an ENOSPC set condition, it runs at highest priority.

Note	Deleting data alone does not trigger cleaner to run and recover space. The properties and settings govern the cleaner.

Usage Guidelines

Accompany the stcli cleaner get-schedule command with one of the optional arguments enclosed in [ ] to return the schedule for a specific node.

• policyActive:False - The cleaner is running at normal Priority.

• policyActive:True - The cleaner is running at high Priority.

Usage Guidelines

Accompany the stcli cleaner info command with one of the optional positional arguments enclosed in [ ] to run the cleaner on a specific node.

Usage Guidelines

Accompany the stcli cleaner report command with one of the positional arguments enclosed in [ ] to return report on a specific node or start the cleaner now.

This command reports the deduplication and compression savings for each of the nodes in the storage cluster, and an aggregate summary of the deduplication and compression savings for the storage cluster. Relevant fields include:

{ 'type': 'cluster', 'id': '' }:
  dedupSavings: 0.0
  compressionSavings: 0.0

Compute only nodes show a dedupSavings of -1.0. This means that the node is not contributing to the managed storage.

Usage Guidelines

Use the stcli cleaner set-schedule to specify a non-default --starttime and --endtime for the cleaner schedule. These two parameters cannot both be zero.

Changes are applied immediately. Restarting the server is not needed.

Usage Guidelines

Accompany the stcli cleaner start command with one of the optional positional arguments enclosed in [ ].

The cleaner starts automatically when the HX Data Platform storage cluster starts. The stcli cleaner start command is used only if the cleaner is manually stopped. When it is manually stopped, it can be manually restarted.

Usage Guidelines

Accompany the stcli cleaner stats command with the optional positional arguments.

Usage Guidelines

Accompany the stcli cleaner stop command with one of the optional positional arguments.

If the cleaner is manually stopped:

• The cleaner starts automatically after a reboot or restart of a storage cluster node.

• The cleaner can be manually restarted.