mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git
synced 2025-12-25 11:50:14 +01:00
a9a30eb08c
nmcli gets NM version and compares it with its own and complains when they differ. This is to indicate that the results are not reliable, because the API could differ. '--nocheck' switches the checks off.
116 lines
4.8 KiB
C
116 lines
4.8 KiB
C
/* nmcli - command-line tool to control NetworkManager
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*
|
|
* (C) Copyright 2010 - 2011 Red Hat, Inc.
|
|
*/
|
|
|
|
#ifndef NMC_NMCLI_H
|
|
#define NMC_NMCLI_H
|
|
|
|
#include <glib.h>
|
|
|
|
#include <nm-client.h>
|
|
#include <nm-remote-settings.h>
|
|
|
|
/* nmcli exit codes */
|
|
typedef enum {
|
|
/* Indicates successful execution */
|
|
NMC_RESULT_SUCCESS = 0,
|
|
|
|
/* Unknown / unspecified error */
|
|
NMC_RESULT_ERROR_UNKNOWN = 1,
|
|
|
|
/* Wrong invocation of nmcli */
|
|
NMC_RESULT_ERROR_USER_INPUT = 2,
|
|
|
|
/* A timeout expired */
|
|
NMC_RESULT_ERROR_TIMEOUT_EXPIRED = 3,
|
|
|
|
/* Error in connection activation */
|
|
NMC_RESULT_ERROR_CON_ACTIVATION = 4,
|
|
|
|
/* Error in connection deactivation */
|
|
NMC_RESULT_ERROR_CON_DEACTIVATION = 5,
|
|
|
|
/* Error in device disconnect */
|
|
NMC_RESULT_ERROR_DEV_DISCONNECT = 6,
|
|
|
|
/* NetworkManager is not running */
|
|
NMC_RESULT_ERROR_NM_NOT_RUNNING = 7,
|
|
|
|
/* nmcli and NetworkManager versions mismatch */
|
|
NMC_RESULT_ERROR_VERSIONS_MISMATCH = 8
|
|
} NMCResultCode;
|
|
|
|
typedef enum {
|
|
NMC_PRINT_TERSE = 0,
|
|
NMC_PRINT_NORMAL = 1,
|
|
NMC_PRINT_PRETTY = 2
|
|
} NMCPrintOutput;
|
|
|
|
/* === Output fields === */
|
|
typedef struct {
|
|
const char *name; /* Field's name */
|
|
const char *name_l10n; /* Field's name for translation */
|
|
int width; /* Width in screen columns */
|
|
const char *value; /* Value of current field */
|
|
guint32 flags; /* Flags */
|
|
} NmcOutputField;
|
|
|
|
/* Flags for NmcPrintFields */
|
|
#define NMC_PF_FLAG_MULTILINE 0x00000001 /* Multiline output instead of tabular */
|
|
#define NMC_PF_FLAG_TERSE 0x00000002 /* Terse output mode */
|
|
#define NMC_PF_FLAG_PRETTY 0x00000004 /* Pretty output mode */
|
|
#define NMC_PF_FLAG_MAIN_HEADER_ADD 0x00000008 /* Print main header in addition to values/field names */
|
|
#define NMC_PF_FLAG_MAIN_HEADER_ONLY 0x00000010 /* Print main header only */
|
|
#define NMC_PF_FLAG_FIELD_NAMES 0x00000020 /* Print field names instead of values */
|
|
#define NMC_PF_FLAG_ESCAPE 0x00000040 /* Escape column separator and '\' */
|
|
#define NMC_PF_FLAG_SECTION_PREFIX 0x00000080 /* Use the first value as section prefix for the other field names - just in multiline */
|
|
|
|
typedef struct {
|
|
GArray *indices; /* Array of field indices to the array of allowed fields */
|
|
char *header_name; /* Name of the output */
|
|
int indent; /* Indent by this number of spaces */
|
|
guint32 flags; /* Various flags for controlling output: see NMC_PF_FLAG_* values */
|
|
} NmcPrintFields;
|
|
|
|
/* NmCli - main structure */
|
|
typedef struct _NmCli {
|
|
NMClient *client; /* Pointer to NMClient of libnm-glib */
|
|
NMClient *(*get_client) (struct _NmCli *nmc); /* Pointer to function for creating NMClient */
|
|
|
|
NMCResultCode return_value; /* Return code of nmcli */
|
|
GString *return_text; /* Reason text */
|
|
|
|
int timeout; /* Operation timeout */
|
|
|
|
NMRemoteSettings *system_settings; /* System settings */
|
|
gboolean system_settings_running; /* Is system settings service running? */
|
|
GSList *system_connections; /* List of system connections */
|
|
|
|
gboolean should_wait; /* Indication that nmcli should not end yet */
|
|
gboolean nowait_flag; /* '--nowait' option; used for passing to callbacks */
|
|
NMCPrintOutput print_output; /* Output mode */
|
|
gboolean multiline_output; /* Multiline output instead of default tabular */
|
|
gboolean mode_specified; /* Whether tabular/multiline mode was specified via '--mode' option */
|
|
gboolean escape_values; /* Whether to escape ':' and '\' in terse tabular mode */
|
|
char *required_fields; /* Required fields in output: '--fields' option */
|
|
NmcOutputField *allowed_fields; /* Array of allowed fields for particular commands */
|
|
NmcPrintFields print_fields; /* Structure with field indices to print */
|
|
gboolean nocheck_ver; /* Don't check nmcli and NM versions: option '--nocheck' */
|
|
} NmCli;
|
|
|
|
#endif /* NMC_NMCLI_H */
|