# Module `netapp_ontap.models.volume_rebalancing`

Copyright © 2022 NetApp Inc. All rights reserved.

This file has been automatically generated based on the ONTAP REST API documentation.

## Classes

`class VolumeRebalancingSchema (*, only: Union[Sequence[str], Set[str]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Dict = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: str = None)`

  The fields of the VolumeRebalancing object

  ### Ancestors

  - netapp_ontap.resource.ResourceSchema
  - marshmallow.schema.Schema
  - marshmallow.base.SchemaABC

  ### Class variables

  `data_moved: Size GET`

    The amount of data that has been moved in or out of a constituent. A positive value represents data moving into the constituent while a negative value is data moving out of the constituent.

  `exclude_snapshots: bool GET PATCH`

    Specifies whether or not to exclude files that are stuck in Snapshot copies during rebalancing operation. When a new capacity rebalancing operation is started on a FlexGroup volume, it uses the current "exclude_snapshots" value. Once the operation is started, any changes to the "exclude_snapshots" value do not affect the currently running capacity rebalancing operation. Only future capacity rebalancing operations will use the new "exclude_snapshots" value.

  `failure_reason: VolumeRebalancing1FailureReason GET POST PATCH`

    The failure_reason field of the volume_rebalancing.

  `imbalance_percent: Size GET`

    Represents the percentage the volume is out of balance.

  `imbalance_size: Size GET`

    Represents how much the volume is out of balance, in bytes.

  `links: SelfLink GET`

    The links field of the volume_rebalancing.

  `max_constituent_imbalance_percent: Size GET`

    Absolute percentage of the constituent that is most out of balance.

  `max_file_moves: Size GET PATCH`

    Specifies the maximum number of file moves in a volume capacity rebalancing operation on a constituent of the FlexGroup volume. When a new capacity rebalancing operation is started on a FlexGroup volume, it uses the current "max_file_moves" value. Once the operation is started, any changes to the "max_file_moves" value do not affect the currently running capacity rebalancing operation. Only future capacity rebalancing operations will use the new "max_file_moves" value.

  `max_runtime: str GET PATCH`

    This optional field specifies the maximum time a capacity rebalancing operation runs for. Once the maximum runtime has passed, the capacity rebalancing operation stops. If it is not set, the default value is 6 hours. This value cannot be updated while a capacity rebalancing operation is running. The maximum runtime can be in years, months, days, hours, and minutes. A period specified for years, months, and days is represented in the ISO-8601 format as "PY", "PM", "PD" respectively, for example "P3D" represents a duration of 3 days. A duration in hours and minutes is represented by "PTH" and "PTM" respectively.

  `max_threshold: Size GET PATCH`

    Specifies the maximum imbalance percentage for FlexGroup volume constituents. When a constituent's imbalance percentage is larger than this value, files are moved from the constituent. When a new capacity rebalancing operation is started on a FlexGroup volume, it uses the current "max_threshold" value. Once the operation is started, any changes to the "max_threshold" value do not affect the currently running capacity rebalancing operation. Only future capacity rebalancing operations will use the new "max_threshold" value.

  `min_file_size: Size GET PATCH`

    Specifies the minimum file size to consider for a volume capacity rebalancing operation. When a new capacity rebalancing operation is started on a FlexGroup volume, it uses the current "min_file_size" value. Once the operation is started, any changes to the "min_file_size" value do not affect the currently running capacity rebalancing operation. Only future capacity rebalancing operations will use the new "min_file_size" value. The value must be a multiple of 4KB. If it is not set, the default value will be 4KB.

  `min_threshold: Size GET PATCH`

    Specifies the minimum imbalance percentage for FlexGroup volume constituents. When a constituent's imbalance percentage is smaller than this value, files are not moved from the constituent. When a new capacity rebalancing operation is started on a FlexGroup volume, it will use the current "min_threshold" value. Once the operation is started, any changes to the "min_threshold" value do not affect the currently running capacity rebalancing operation. Only future capacity rebalancing operations will use the new "min_threshold" value.

  `runtime: str GET`

    Duration the capacity rebalancing operation has been running.

  `start_time: ImpreciseDateTime GET`

    Time when the current capacity rebalancing operation started.

  `state: str GET PATCH`

    State of volume capacity rebalancing operation. PATCH the state to "starting" to trigger the capacity rebalance operation. PATCH the state to "stopping" to stop the capacity rebalance operation.

    Valid choices:

    - idle
    - starting
    - rebalancing
    - rebalancing_source
    - rebalancing_dest
    - scanning
    - stopping
    - paused
    - not_running
    - unknown
  `stop_time: ImpreciseDateTime GET`

    Time when the capacity rebalancing operation stopped.

  `target_used: Size GET`

    Represents the ideal used size of each constituent. Calculated by dividing the total FlexGroup volume used size by the number of constituents.