Skip to content

CHANNELCTL

NAME

1
channelctl : manage your channels.

SYNOPSIS

1
channelctl --tenant mytenant

DESCRIPTION

The channelctl command is the main command to manage your channels. It allows you to start stop or query the status of your channels and punchlines.

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

channelctl --tenant <tenant_name>

Where <tenant_name> is a tenant name. From there, follow the documented commands. Use the TAB character to get auto-completion.

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

channelctl --tenant <tenant_name> <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

    • Stop channels or jobs.
  • describe

    • Print a description of the current channel and job state.
  • configuration

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

    • clear and reset the screen
  • --channel

    • execute the command for a selected channel. a '' wildcard can be used in the channel name to apply the same command to multiple channels. (e.g. : start --channel output_ )
  • --punchline

    • execute the command for a selected application an application name is composed of <channel>/<runtime_id>/<punchline_name> the runtime_id/punchline_name must be a valid combination from the channel_structure.json file. Wildcard ('*') can be used in any part of this job Id, to apply the same command to multiple channels/clusters/jobs

EXAMPLES

Here are some self explanatory examples

channelctl --tenant mytenant status 
channelctl --tenant mytenant status --channel sourcefire
channelctl --tenant mytenant start --channel sourcefire
channelctl --tenant mytenant start --job */main/to_elasticsearch_topology

LIBRARIES

channelctl uses the library located :

  • $PUNCHPLATFORM_INSTALL_DIR/lib/punchplatform-command-cli*with-dependencies.jar

LOGGERS

The logging verbosity of channelctl is controlled by the following two files:

  • $PUNCHPLATFORM_LOG4J_CONF_DIR/log4j2-channelctl.xml
  • $PUNCHPLATFORM_LOG4J_CONF_DIR/log4j2.properties

Note that these loggers use the file appenders.

ENVIRONMENT

channelctl is only executed in the context of the operator terminal environment.

SEE ALSO

punchlinectl environment