esp_cnc

Connects to the Event Stream Processor via the Command and Control and Gateway interfaces, and issues simple command and control commands to the server. It prints the results on the standard output.

Syntax

esp_cnc -C command -p [host:]port/workspace-name/project-name -c user[:password] [OPTION]

Required Arguments

-C command – (required) may be one of these literals: getGateway, getBaseStreams, getDerivedStreams, getStreamDefinition, getAddressSize, getDateSize, sendStreamsExit, augmentSubscriber, removeSubscriber, isBigEndian, isQuiesced, isQuiescedNow, returnWhenQuiesced, setParam, getVersion, getStreamHandle
-c user[:password] – (required) authenticates with a user ID and, optionally, a password. If you do not provide either the password or the -k or -G option, the user is prompted for the password. If the Event Stream Processor successfully authenticates with these credentials, the connection is maintained, otherwise the Event Stream Processor immediately closes the connection.
-p [<host>:]<port>/workspace-name/project-name – (required) together, the host:<port>/<workspace name>/ <project name> arguments specify the URI to connect to the ESP Server (cluster manager). For example, if you have started your ESP cluster server in the port 19011, the host name is set as localhost, and you are running a project called prj1 in the default workspace, specify -p as: -p localhost:19011/default/prj1

Options

-e – (dependent required) encrypts traffic via openSSL. When this option is not present, no encryption occurs.
-G – (optional) authenticates access to the Event Stream Processor with credentials held within a Kerberos authentication ticket. Environment variables determine where the system will look to find authentication tickets (See Administrators Guide > Security in the Event Stream Processor > Authentication > Setting Environment Variables for Kerberos for more information). If the user name differs from the default principal name in the ticket cache, specify an alternate user name with the –c option to use the corresponding authentication ticket.
-h – (optional) a list of possible options on the screen along with a brief explanation for each option.
-H handle – (dependent required) specifies the client handle to direct an augmentSubscriber or removeSubscriber command. This option is required for those commands.
-k privateRsaKeyFile – (optional) performs authentication using the RSA private key file mechanism instead of password authentication. The privateRsaKeyFile must specify the pathname of the private RSA key file. This option is required if the ESP Server was started with the -V rsa option. With this option enabled, the user name must be specified with the -c option, but the password is not required.
Note: Ensure that the ESP Server has been started with the -k option specifying the directory in which to store the RSA keys.
-P name:value – (dependent required) specifies the new value to be associated with a variable. Required for the setParam option. You cannot set the value of a parameter in a running project; use the -P option to set new values for variables only.
-s stream – (dependent required) specifies a single stream. Required for the commands getStreamDefinition, augmentSubscriber, getStreamHandle and removeSubscriber.