logo
logo

Class ListCommand

List orders.

Inheritance
System.Object
Sitecore.CH.Cli.Core.Abstractions.Commands.BaseCommand<Sitecore.CH.Cli.Plugin.Jobs.CommandHandlers.ListCommandHandler>
ListCommand
Namespace: Sitecore.CH.Cli.Plugin.Jobs.Commands
Assembly: Sitecore.CH.Cli.Plugin.Jobs.dll
Syntax
public class ListCommand : BaseCommand<ListCommandHandler>
Remarks

Optional parameters

  • --filter -f Refines the list of results.
  • --sort -s Sorts the list of results.
  • --order -o Defines the sort order. Default value is Desc.
  • --output Specifies the output format. Allowed values: Table, Json
  • --endpoint -e Specifies an alternative endpoint name for the execution of this command.

Global parameters

  • -? --help -h Show this help message and exit.
  • -v --verbosity Enables verbose logging.
Examples

With filters:

ch-cli jobs list -f "<value>"

If filter value is an integer the results are filter by 'Number of targets', otherwise the results are filtered by Condition or State or Type that contains the entered value. With sorting:

ch-cli jobs list -o "<property name>"

Can we improve this article ? Provide feedback