com.tailf.maapi

Enum MaapiConfigFlag

Object

Enum<MaapiConfigFlag>

com.tailf.maapi.MaapiConfigFlag

All Implemented Interfaces:

Serializable, Comparable<MaapiConfigFlag>

public enum MaapiConfigFlag
extends Enum<MaapiConfigFlag>

Flags used in Maapi.saveConfig(int,EnumSet,String,Object... ) and Maapi.loadConfig(int,EnumSet,String).

Enum Constant Summary

Enum Constants

Enum Constant and Description
CISCO_IOS_FORMAT Save/Load config flag indicating Cisco IOS style configuration format.
CISCO_XR_FORMAT Save/Load config flag indicating Cisco XR style configuration format.
CONFIG_AUTOCOMMIT The flag can be used together with MaapiConfigFlag.MAAPI_CONFIG_C and MaapiConfigFlag.MAAPI_CONFIG_C_IOS to mean that a commit should be performed after each line
CONFIG_CDB_ONLY The output of saveConfig will only include data stored in CDB.
CONFIG_CONTINUE_ON_ERROR The flag can be used to indicate that the load should not be aborted when an error is encountered.
CONFIG_HIDE_ALL Hide all hidden nodes.
CONFIG_NO_PARENTS The output of saveConfig will begin at path instead of root.
CONFIG_OPER_ONLY The output of saveConfig will only include operational data and ancestors to operational data nodes.
CONFIG_REPLACE To replace only the part of the configuration that is present in the file.
CONFIG_SUPPRESS_ERRORS The flag is used to suppress the long error messages but instead have a one line error with the line number.
CONFIG_UNHIDE_ALL Unhide all hidden nodes (see below).
CONFIG_WITH_SERVICE_META The flag can be used to request that NCS service-meta-data attributes should be included when saving configuration.
CONFIG_XML_LOAD_LAX The flag can be used together with MaapiConfigFlag.XML_FORMAT.
JSON_FORMAT The configuration format is JSON.
JUNIPER_CLI_FORMAT Save/Load config flag indicating curly brace Juniper CLI configuration format.
MAAPI_CONFIG_AUTOCOMMIT Same as MaapiConfigFlag.CONFIG_AUTOCOMMIT
MAAPI_CONFIG_C Same as MaapiConfigFlag.CISCO_XR_FORMAT
MAAPI_CONFIG_C_IOS Same as MaapiConfigFlag.CISCO_IOS_FORMAT
MAAPI_CONFIG_CDB_ONLY Same as MaapiConfigFlag.CONFIG_CDB_ONLY
MAAPI_CONFIG_CONTINUE_ON_ERROR Same as MaapiConfigFlag.CONFIG_CONTINUE_ON_ERROR
MAAPI_CONFIG_HIDE_ALL Same as MaapiConfigFlag.CONFIG_HIDE_ALL
MAAPI_CONFIG_J Same as MaapiConfigFlag.JUNIPER_CLI_FORMAT
MAAPI_CONFIG_JSON Same as MaapiConfigFlag.JSON_FORMAT
MAAPI_CONFIG_MERGE Same as MaapiConfigFlag.MERGE_CONFIGURATIONS
MAAPI_CONFIG_NO_BACKQUOTE Same as MaapiConfigFlag.CONFIG_AUTOCOMMIT
MAAPI_CONFIG_NO_PARENTS Same as MaapiConfigFlag.CONFIG_NO_PARENTS
MAAPI_CONFIG_OPER_ONLY Same as MaapiConfigFlag.CONFIG_OPER_ONLY
MAAPI_CONFIG_READ_WRITE_ACCESS_ONLY The output of saveConfig will only include nodes for which the user has read_write access.
MAAPI_CONFIG_REPLACE Same as MaapiConfigFlag.CONFIG_REPLACE
MAAPI_CONFIG_SHOW_DEFAULTS Same as MaapiConfigFlag.WITH_DEFAULTS
MAAPI_CONFIG_SUPPRESS_ERRORS Same as MaapiConfigFlag.CONFIG_SUPPRESS_ERRORS
MAAPI_CONFIG_UNHIDE_ALL Same as MaapiConfigFlag.CONFIG_UNHIDE_ALL
MAAPI_CONFIG_WITH_DEFAULTS Same as MaapiConfigFlag.WITH_DEFAULTS
MAAPI_CONFIG_WITH_OPER Same as MaapiConfigFlag.WITH_OPER
MAAPI_CONFIG_WITH_SERVICE_META Same as MaapiConfigFlag.CONFIG_WITH_SERVICE_META
MAAPI_CONFIG_XML Same as MaapiConfigFlag.XML_FORMAT
MAAPI_CONFIG_XML_LOAD_LAX Same as MaapiConfigFlag.CONFIG_XML_LOAD_LAX
MAAPI_CONFIG_XML_PRETTY Same as MaapiConfigFlag.XPATH
MAAPI_CONFIG_XPATH Same as MaapiConfigFlag.XPATH
MERGE_CONFIGURATIONS Load config flag indicating that current configuration should be merged with the loaded data instead of deleted.
SHOW_DEFAULTS Save/Load config flag indicating that default values are also included next to the real configuration value.
WITH_DEFAULTS Save/Load config flag indicating that default values are included as part of the configuration.
WITH_OPER Load config flag used in conjunction with MaapiConfigFlag.MAAPI_CONFIG_XML to indicated that operational data should be ignored instead of producing an error.
XML_FORMAT Save/Load config flag indicating XML configuration format.
XML_PRETTY The configuration format is pretty printed XML.
XPATH The fmtpath and remaining arguments give an XPath filter instead of a keypath.

Method Summary

Modifier and Type	Method and Description
int	getValue()
static MaapiConfigFlag	valueOf(String name) Returns the enum constant of this type with the specified name.
static MaapiConfigFlag[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

XML_FORMAT

public static final MaapiConfigFlag XML_FORMAT

Save/Load config flag indicating XML configuration format.

MAAPI_CONFIG_XML

public static final MaapiConfigFlag MAAPI_CONFIG_XML

Same as MaapiConfigFlag.XML_FORMAT

JUNIPER_CLI_FORMAT

public static final MaapiConfigFlag JUNIPER_CLI_FORMAT

Save/Load config flag indicating curly brace Juniper CLI configuration format.

MAAPI_CONFIG_J

public static final MaapiConfigFlag MAAPI_CONFIG_J

Same as MaapiConfigFlag.JUNIPER_CLI_FORMAT

CISCO_XR_FORMAT

public static final MaapiConfigFlag CISCO_XR_FORMAT

Save/Load config flag indicating Cisco XR style configuration format.

MAAPI_CONFIG_C

public static final MaapiConfigFlag MAAPI_CONFIG_C

Same as MaapiConfigFlag.CISCO_XR_FORMAT

WITH_DEFAULTS

public static final MaapiConfigFlag WITH_DEFAULTS

Save/Load config flag indicating that default values are included as part of the configuration.

MAAPI_CONFIG_WITH_DEFAULTS

public static final MaapiConfigFlag MAAPI_CONFIG_WITH_DEFAULTS

Same as MaapiConfigFlag.WITH_DEFAULTS

SHOW_DEFAULTS

public static final MaapiConfigFlag SHOW_DEFAULTS

Save/Load config flag indicating that default values are also included next to the real configuration value.

MAAPI_CONFIG_SHOW_DEFAULTS

public static final MaapiConfigFlag MAAPI_CONFIG_SHOW_DEFAULTS

Same as MaapiConfigFlag.WITH_DEFAULTS

CISCO_IOS_FORMAT

public static final MaapiConfigFlag CISCO_IOS_FORMAT

Save/Load config flag indicating Cisco IOS style configuration format.

MAAPI_CONFIG_C_IOS

public static final MaapiConfigFlag MAAPI_CONFIG_C_IOS

Same as MaapiConfigFlag.CISCO_IOS_FORMAT

MERGE_CONFIGURATIONS

public static final MaapiConfigFlag MERGE_CONFIGURATIONS

Load config flag indicating that current configuration should be merged with the loaded data instead of deleted.

MAAPI_CONFIG_MERGE

public static final MaapiConfigFlag MAAPI_CONFIG_MERGE

Same as MaapiConfigFlag.MERGE_CONFIGURATIONS

WITH_OPER

public static final MaapiConfigFlag WITH_OPER

Load config flag used in conjunction with MaapiConfigFlag.MAAPI_CONFIG_XML to indicated that operational data should be ignored instead of producing an error.

MAAPI_CONFIG_WITH_OPER

public static final MaapiConfigFlag MAAPI_CONFIG_WITH_OPER

Same as MaapiConfigFlag.WITH_OPER

XPATH

public static final MaapiConfigFlag XPATH

The fmtpath and remaining arguments give an XPath filter instead of a keypath. XPath filtering for path to Maapi.saveConfig(int,EnumSet,String,Object... ) can only be used with MaapiConfigFlag.MAAPI_CONFIG_XML and MaapiConfigFlag.MAAPI_CONFIG_XML_PRETTY.

MAAPI_CONFIG_XPATH

public static final MaapiConfigFlag MAAPI_CONFIG_XPATH

Same as MaapiConfigFlag.XPATH

XML_PRETTY

public static final MaapiConfigFlag XML_PRETTY

The configuration format is pretty printed XML.

MAAPI_CONFIG_XML_PRETTY

public static final MaapiConfigFlag MAAPI_CONFIG_XML_PRETTY

Same as MaapiConfigFlag.XPATH

CONFIG_REPLACE

public static final MaapiConfigFlag CONFIG_REPLACE

To replace only the part of the configuration that is present in the file.

MAAPI_CONFIG_REPLACE

public static final MaapiConfigFlag MAAPI_CONFIG_REPLACE

Same as MaapiConfigFlag.CONFIG_REPLACE

CONFIG_HIDE_ALL

public static final MaapiConfigFlag CONFIG_HIDE_ALL

Hide all hidden nodes.

MAAPI_CONFIG_HIDE_ALL

public static final MaapiConfigFlag MAAPI_CONFIG_HIDE_ALL

Same as MaapiConfigFlag.CONFIG_HIDE_ALL

CONFIG_UNHIDE_ALL

public static final MaapiConfigFlag CONFIG_UNHIDE_ALL

Unhide all hidden nodes (see below).

MAAPI_CONFIG_UNHIDE_ALL

public static final MaapiConfigFlag MAAPI_CONFIG_UNHIDE_ALL

Same as MaapiConfigFlag.CONFIG_UNHIDE_ALL

CONFIG_AUTOCOMMIT

public static final MaapiConfigFlag CONFIG_AUTOCOMMIT

The flag can be used together with MaapiConfigFlag.MAAPI_CONFIG_C and MaapiConfigFlag.MAAPI_CONFIG_C_IOS to mean that a commit should be performed after each line

MAAPI_CONFIG_AUTOCOMMIT

public static final MaapiConfigFlag MAAPI_CONFIG_AUTOCOMMIT

Same as MaapiConfigFlag.CONFIG_AUTOCOMMIT

CONFIG_CONTINUE_ON_ERROR

public static final MaapiConfigFlag CONFIG_CONTINUE_ON_ERROR

The flag can be used to indicate that the load should not be aborted when an error is encountered.

MAAPI_CONFIG_CONTINUE_ON_ERROR

public static final MaapiConfigFlag MAAPI_CONFIG_CONTINUE_ON_ERROR

Same as MaapiConfigFlag.CONFIG_CONTINUE_ON_ERROR

CONFIG_SUPPRESS_ERRORS

public static final MaapiConfigFlag CONFIG_SUPPRESS_ERRORS

The flag is used to suppress the long error messages but instead have a one line error with the line number.

MAAPI_CONFIG_SUPPRESS_ERRORS

public static final MaapiConfigFlag MAAPI_CONFIG_SUPPRESS_ERRORS

Same as MaapiConfigFlag.CONFIG_SUPPRESS_ERRORS

CONFIG_XML_LOAD_LAX

public static final MaapiConfigFlag CONFIG_XML_LOAD_LAX

The flag can be used together with MaapiConfigFlag.XML_FORMAT. Indicates that relaxed parsing shall be done. Unknown XML elements are silently ignored.

MAAPI_CONFIG_XML_LOAD_LAX

public static final MaapiConfigFlag MAAPI_CONFIG_XML_LOAD_LAX

Same as MaapiConfigFlag.CONFIG_XML_LOAD_LAX

JSON_FORMAT

public static final MaapiConfigFlag JSON_FORMAT

The configuration format is JSON.

MAAPI_CONFIG_JSON

public static final MaapiConfigFlag MAAPI_CONFIG_JSON

Same as MaapiConfigFlag.JSON_FORMAT

CONFIG_WITH_SERVICE_META

public static final MaapiConfigFlag CONFIG_WITH_SERVICE_META

The flag can be used to request that NCS service-meta-data attributes should be included when saving configuration.

MAAPI_CONFIG_WITH_SERVICE_META

public static final MaapiConfigFlag MAAPI_CONFIG_WITH_SERVICE_META

Same as MaapiConfigFlag.CONFIG_WITH_SERVICE_META

CONFIG_NO_PARENTS

public static final MaapiConfigFlag CONFIG_NO_PARENTS

The output of saveConfig will begin at path instead of root.

MAAPI_CONFIG_NO_PARENTS

public static final MaapiConfigFlag MAAPI_CONFIG_NO_PARENTS

Same as MaapiConfigFlag.CONFIG_NO_PARENTS

CONFIG_OPER_ONLY

public static final MaapiConfigFlag CONFIG_OPER_ONLY

The output of saveConfig will only include operational data and ancestors to operational data nodes.

MAAPI_CONFIG_OPER_ONLY

public static final MaapiConfigFlag MAAPI_CONFIG_OPER_ONLY

Same as MaapiConfigFlag.CONFIG_OPER_ONLY

MAAPI_CONFIG_NO_BACKQUOTE

public static final MaapiConfigFlag MAAPI_CONFIG_NO_BACKQUOTE

Same as MaapiConfigFlag.CONFIG_AUTOCOMMIT

CONFIG_CDB_ONLY

public static final MaapiConfigFlag CONFIG_CDB_ONLY

The output of saveConfig will only include data stored in CDB.

MAAPI_CONFIG_CDB_ONLY

public static final MaapiConfigFlag MAAPI_CONFIG_CDB_ONLY

Same as MaapiConfigFlag.CONFIG_CDB_ONLY

MAAPI_CONFIG_READ_WRITE_ACCESS_ONLY

public static final MaapiConfigFlag MAAPI_CONFIG_READ_WRITE_ACCESS_ONLY

The output of saveConfig will only include nodes for which the user has read_write access.

Method Detail

values

public static MaapiConfigFlag[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MaapiConfigFlag c : MaapiConfigFlag.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MaapiConfigFlag valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()