Skip to content

punchctl

NAME

punchctl - main command to manage your punch platform.

SYNOPSIS

punchctl [OPTIONS]

DESCRIPTION

The punchctl command is the main command to manage your punch platform. It allows you to start stop or query the status of your channels and jobs.

This command works in two ways. To start an interactive shell, simply launch

1
punchpctl --tenant TENANT

Where TENANT is a tenant name. From there follow the documented commands. Use the TAB character to get autocompletion.

Alternatively you can execute command in non interactive mode using the following syntax:

1
punchpctl --tenant mytenant [OPTIONS] [ARGUMENTS]

Where command is one of the described command you will find using the interactive mode.

OPTIONS

  • status

    • Return a short status information of channels and jobs.
  • start

    • Use an inline punchlet code, Start channels and jobs.
  • stop

    • Change default grok-pattern resources directory (resource/punch/pattern), Stop channels or jobs.
  • describe

    • Print a decription of the channel and job state.
  • configuration

    • Pull or push the tenant configutration from/to the platform configuration store
  • reset

    • clear and reset the screen
  • --channel

    • execute the command for a selected channel
  • --job

    • execute the command for a selected job
  • --json

    • print the result as json

EXAMPLE

Here are some self explanatory examples

1
punchctl --tenant mytenant status 
1
punchctl --tenant mytenant status --channel sourcefire
1
punchctl --tenant mytenant start --channel sourcefire

SEE ALSO

punch

BUGS

No known bugs.