2
0
mirror of https://github.com/openvswitch/ovs synced 2025-08-22 09:58:01 +00:00
ovs/lib/dpctl.h
Ben Pfaff d1fd1ea912 ovs-dpctl: New --names option to use port names in flow dumps.
Until now, printing names in "ovs-dpctl dump-flows" was tied to the overall
output verbosity, which in practice meant that to see port names a user had
to see a distracting amount of verbosity.  This decouples names from
verbosity.

I'd like to make showing names the default for interactive usage, but so
far names aren't accepted in input so that would frustrate cut-and-paste,
which is an important use of "ovs-dpctl dump-flows" output.

Signed-off-by: Ben Pfaff <blp@ovn.org>
Acked-by: Jan Scheurich <jan.scheurich@ericsson.com>
Tested-by: Jan Scheurich <jan.scheurich@ericsson.com>
2017-06-23 16:28:26 +08:00

62 lines
1.8 KiB
C

/*
* Copyright (c) 2014 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef DPCTL_H
#define DPCTL_H 1
#include <stdbool.h>
#include "compiler.h"
struct dpctl_params {
/* True if it is called by ovs-appctl command. */
bool is_appctl;
/* -s, --statistics: Print port/flow statistics? */
bool print_statistics;
/* --clear: Reset existing statistics to zero when modifying a flow? */
bool zero_statistics;
/* --may-create: Allow mod-flows command to create a new flow? */
bool may_create;
/* --read-only: Do not run R/W commands? */
bool read_only;
/* -m, --more: Increase output verbosity. */
int verbosity;
/* --names: Use port names in output? */
bool names;
/* Callback for printing. This function is called from dpctl_run_command()
* to output data. The 'aux' parameter is set to the 'aux'
* member. The 'error' parameter is true if 'string' is an error
* message, false otherwise */
void (*output)(void *aux, bool error, const char *string);
void *aux;
/* 'usage' (if != NULL) gets called for the "help" command. */
void (*usage)(void *aux);
};
int dpctl_run_command(int argc, const char *argv[],
struct dpctl_params *dpctl_p);
void dpctl_unixctl_register(void);
#endif /* dpctl.h */