org.apache.geode.management.cli (Apache Geode 1.13.3)
Date: 2021-06-22

# Package org.apache.geode.management.cli

The Command Line Interface (CLI) package provides a set of APIs for writing commands that can be used to manage and monitor GemFire components.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  CommandStatement | Deprecated since Geode 1.3.
  ConverterHint | Used in `CliOption` annotations to indicate which converter(s) should or should not be used.
  Result | The result of processing a GemFire Command Line Interface (CLI) command string.
  UpdateAllConfigurationGroupsMarker | This interface is implemented by gfsh commands that can potentially update the configuration for all groups (including the cluster-wide group, "cluster").

- Class Summary
  Class | Description
  --- | ---
  CliFunction<T> | An abstract function implementation to be extended by cli functions.
  CommandService | Deprecated since 1.3 use OnlineCommandProcessor directly
  GfshCommand |
  SingleGfshCommand | Command class that extends this class can only have one single command method, i.e only one method that is annotated with @CliCommand.

- Enum Summary
  Enum | Description
  --- | ---
  Result.Status | Indicates a Results status.

- Exception Summary
  Exception | Description
  --- | ---
  CommandProcessingException | Indicates that an exception occurred while processing a GemFire Command Line Interface (CLI) command.
  CommandServiceException | Indicates that an exception occurred while accessing/creating a Command Service for processing GemFire Command Line Interface (CLI) commands.

- Annotation Types Summary
  Annotation Type | Description
  --- | ---
  CliMetaData | An annotation to define additional meta-data for commands.
  CliMetaData.AvailabilityMetadata | Deprecated since Geode1.2, not used at all
  Disabled | This annotation disables a `GfshCommand` class from being loaded by the `CommandManager` unless the provided flag value exists in the VM's environment.

## Package org.apache.geode.management.cli Description

The Command Line Interface (CLI) package provides a set of APIs for writing commands that can be used to manage and monitor GemFire components. This interface is currently used by the GemFire SHell (GFSH) command line utility, but may be used to create custom commands which build upon that functionality.