cloudvision.api.arista.configstatus.v1 package

Module contents

class cloudvision.api.arista.configstatus.v1.ConfigError(error_code: ErrorCode = <PLACEHOLDER>, error_msg: str | None = <PLACEHOLDER>, line_num: int | None = <PLACEHOLDER>, configlet_name: str | None = <PLACEHOLDER>)[source]

Bases: Message

ConfigError represents errors reported by CVP/EOS when handling device configuration

configlet_name: str | None = <PLACEHOLDER>: configlet_name represents the originating configlet name. Configlet_name and line_num point to the line where config warning or config error originate.

error_code: ErrorCode = <PLACEHOLDER>: error_code - type of error.

error_msg: str | None = <PLACEHOLDER>: error_msg - details of error

line_num: int | None = <PLACEHOLDER>: line_num represents line number, if any

class cloudvision.api.arista.configstatus.v1.ConfigErrors(values: List[ConfigError] = <PLACEHOLDER>)[source]

Bases: Message

ConfigErrors list of errors

values: List[ConfigError] = <PLACEHOLDER>: values - list of errors

class cloudvision.api.arista.configstatus.v1.ConfigFilterCode(value: int)[source]

Bases: Enum

ConfigFilterCode indicates if a config line matches PCM filter(s)

MANAGED_LINE = ConfigFilterCode.MANAGED_LINE: CONFIG_FILTER_CODE_MANAGED_LINE indicates config line matches managed PCM filter hence is managed

UNMANAGED_LINE = ConfigFilterCode.UNMANAGED_LINE: CONFIG_FILTER_CODE_UNMANAGED_LINE indicates config line matches unmanaged PCM filter hence is not managed

UNSPECIFIED = ConfigFilterCode.UNSPECIFIED: CONFIG_FILTER_CODE_UNSPECIFIED uninitialized

name: str | None

value: int

class cloudvision.api.arista.configstatus.v1.ConfigSource(source_type: ConfigSourceType = <PLACEHOLDER>, source_id: str | None = <PLACEHOLDER>)[source]

Bases: Message

ConfigSource describes an individual source of the proposed/designed config

source_id: str | None = <PLACEHOLDER>: source_id identifier to distinguish between multiple instances of the source type source_id is :

configlet name for CONFIG_SOURCE_TYPE_NETWORK_PROVISIONING_CONFIGLET studio id for CONFIG_SOURCE_TYPE_STUDIO configlet id for CONFIG_SOURCE_TYPE_STUDIO_STATIC FixtureInstance id for CONFIG_SOURCE_TYPE_HIERARCHY

source_type: ConfigSourceType = <PLACEHOLDER>: source_type - app type of the config snippet

class cloudvision.api.arista.configstatus.v1.ConfigSourceType(value: int)[source]

Bases: Enum

ConfigSourceType indicates the type of source for the proposed/designed configuration for the device

HIERARCHY = ConfigSourceType.HIERARCHY: CONFIG_SOURCE_TYPE_HIERARCHY - config from the hierarchy frameork

NETWORK_PROVISIONING_CONFIGLET = ConfigSourceType.NETWORK_PROVISIONING_CONFIGLET: CONFIG_SOURCE_TYPE_NETWORK_PROVISIONING_CONFIGLET - configlet created from the network provisioning workflow.

STUDIO = ConfigSourceType.STUDIO: CONFIG_SOURCE_TYPE_STUDIO - config generated from a regular studio

STUDIO_STATIC = ConfigSourceType.STUDIO_STATIC: CONFIG_SOURCE_TYPE_STUDIO_STATIC - static config from studios framework

UNSPECIFIED = ConfigSourceType.UNSPECIFIED: CONFIG_SOURCE_TYPE_UNSPECIFIED uninitialized value

name: str | None

value: int

class cloudvision.api.arista.configstatus.v1.ConfigSources(values: List[ConfigSource] = <PLACEHOLDER>)[source]

Bases: Message

ConfigSources is the list of sources of the proposed/designed config

values: List[ConfigSource] = <PLACEHOLDER>: values - ordered list of all the config snippets present in DC

class cloudvision.api.arista.configstatus.v1.ConfigSummary(sync: ConfigSyncCode = <PLACEHOLDER>, nop_lines: int | None = <PLACEHOLDER>, ignored_lines: int | None = <PLACEHOLDER>, added_lines: int | None = <PLACEHOLDER>, deleted_lines: int | None = <PLACEHOLDER>, changed_lines: int | None = <PLACEHOLDER>, designed_config_errors: int | None = <PLACEHOLDER>, designed_config_warnings: int | None = <PLACEHOLDER>, running_config_update_time: datetime = <PLACEHOLDER>, designed_config_update_time: datetime = <PLACEHOLDER>, running_config_uri: str | None = <PLACEHOLDER>, designed_config_uri: str | None = <PLACEHOLDER>, diff_uri: str | None = <PLACEHOLDER>, digest: str | None = <PLACEHOLDER>)[source]

Bases: Message

ConfigSummary represents device configuration summary.

added_lines: int | None = <PLACEHOLDER>: added_lines - Number of lines with code ADD

changed_lines: int | None = <PLACEHOLDER>: changed_lines - Number of lines with code CHANGE

deleted_lines: int | None = <PLACEHOLDER>: deleted_lines - Number of lines with code DELETE

designed_config_errors: int | None = <PLACEHOLDER>: designed_config_errors - Number of designed config errors

designed_config_update_time: datetime = <PLACEHOLDER>: designed_config_update_time - Timestamp at which designed config is updated

designed_config_uri: str | None = <PLACEHOLDER>: designed_config_uri - The HTTP URI client can use to GET designed config and associated errors

designed_config_warnings: int | None = <PLACEHOLDER>: designed_config_warnings - Number of designed config warnings

diff_uri: str | None = <PLACEHOLDER>: diff_uri - The HTTP URI client can use to GET config diff and associated errors

digest: str | None = <PLACEHOLDER>: digest (SHA-256) of the config diff.

ignored_lines: int | None = <PLACEHOLDER>: ignored_lines - Number of lines with code IGNORE

nop_lines: int | None = <PLACEHOLDER>: nop_lines - Number of lines with code no-operation

running_config_update_time: datetime = <PLACEHOLDER>: running_config_update_time - Timestamp at which running config is updated

running_config_uri: str | None = <PLACEHOLDER>: running_config_uri - The HTTP URI client can use to GET running config and associated errors

sync: ConfigSyncCode = <PLACEHOLDER>: sync - state of DC vs RC

class cloudvision.api.arista.configstatus.v1.ConfigSyncCode(value: int)[source]

Bases: Enum

ConfigSyncCode indicates config synchronization status

IN_SYNC = ConfigSyncCode.IN_SYNC: CONFIG_SYNC_CODE_IN_SYNC indicates designed config and running config are identical

OUT_OF_SYNC = ConfigSyncCode.OUT_OF_SYNC: CONFIG_SYNC_CODE_OUT_OF_SYNC indicates designed config and running config are not identical

UNSPECIFIED = ConfigSyncCode.UNSPECIFIED: CONFIG_SYNC_CODE_UNSPECIFIED uninitialized

name: str | None

value: int

class cloudvision.api.arista.configstatus.v1.ConfigType(value: int)[source]

Bases: Enum

ConfigType - specifies type of config

DESIGNED_CONFIG = ConfigType.DESIGNED_CONFIG: CONFIG_TYPE_DESIGNED_CONFIG uninitialized value

RUNNING_CONFIG = ConfigType.RUNNING_CONFIG: CONFIG_TYPE_RUNNING_CONFIG uninitialized value

UNSPECIFIED = ConfigType.UNSPECIFIED: CONFIG_TYPE_UNSPECIFIED uninitialized value

name: str | None

value: int

class cloudvision.api.arista.configstatus.v1.DiffEntries(values: List[DiffEntry] = <PLACEHOLDER>)[source]

Bases: Message

DiffEntries indicates potential multiple lines of config diff

values: List[DiffEntry] = <PLACEHOLDER>: values - list of diff entries

class cloudvision.api.arista.configstatus.v1.DiffEntry(op: DiffOp = <PLACEHOLDER>, a_line_num: int | None = <PLACEHOLDER>, b_line_num: int | None = <PLACEHOLDER>, b_parent_line_num: int | None = <PLACEHOLDER>, a_line: str | None = <PLACEHOLDER>, b_line: str | None = <PLACEHOLDER>, a_filter_code: ConfigFilterCode = <PLACEHOLDER>, b_filter_code: ConfigFilterCode = <PLACEHOLDER>, a_parent_line_num: int | None = <PLACEHOLDER>, is_a_default_command: bool | None = <PLACEHOLDER>)[source]

Bases: Message

DiffEntry represents one entry in a Diff

a_filter_code: ConfigFilterCode = <PLACEHOLDER>: a_filter_code represents the config filter code for the line in A

a_line: str | None = <PLACEHOLDER>: a_line is the content of config line in A

a_line_num: int | None = <PLACEHOLDER>: a_line_num indicates the line number in A where the diff is applied

a_parent_line_num: int | None = <PLACEHOLDER>: a_parent_line_num represents the line number of the parent command in A

b_filter_code: ConfigFilterCode = <PLACEHOLDER>: b_filter_code represents the config filter code for the line in B

b_line: str | None = <PLACEHOLDER>: b_line is the content of config line in B

b_line_num: int | None = <PLACEHOLDER>: b_line_num indicates the line number in B where this diff is applied

b_parent_line_num: int | None = <PLACEHOLDER>: b_parent_line_num represents the line number of the parent command in B

is_a_default_command: bool | None = <PLACEHOLDER>: is_a_default_command indicates that config line in A is a default command that is generated by EOS.

op: DiffOp = <PLACEHOLDER>: op specifies type of diff operation

class cloudvision.api.arista.configstatus.v1.DiffOp(value: int)[source]

Bases: Enum

DiffOp is the operation to a line from one side of diff to get to another

ADD = DiffOp.ADD: DIFF_OP_ADD is an addition of a line from A

CHANGE = DiffOp.CHANGE: DIFF_OP_CHANGE is a modification to a line in A

DELETE = DiffOp.DELETE: DIFF_OP_DELETE is deletion of a line from B

IGNORE = DiffOp.IGNORE: DIFF_OP_IGNORE indicates a line that’s ignored in either A or B. One of a_line_num or b_line_num will be -1

NOP = DiffOp.NOP: DIFF_OP_NOP indicates no change. A and B are identical at this line

UNSPECIFIED = DiffOp.UNSPECIFIED: DIFF_OP_UNSPECIFIED uninitialized

name: str | None

value: int

class cloudvision.api.arista.configstatus.v1.ErrorCode(value: int)[source]

Bases: Enum

ErrorCode indicates warnings and errors produced during computing config

CONFIG_FILTER_ERROR = ErrorCode.CONFIG_FILTER_ERROR: ERROR_CODE_CONFIG_FILTER_ERROR indicates error from partial config management filters

DEVICE_ERROR = ErrorCode.DEVICE_ERROR: ERROR_CODE_DEVICE_ERROR indicates device error

DEVICE_WARNING = ErrorCode.DEVICE_WARNING: ERROR_CODE_DEVICE_WARNING indicates device warning

INTERNAL = ErrorCode.INTERNAL: ERROR_CODE_INTERNAL indicates internal errors

PROPOSED_CONFIG_CHECK = ErrorCode.PROPOSED_CONFIG_CHECK: ERROR_CODE_PROPOSED_CONFIG_CHECK indicates an issue with the content of proposed configuration.

UNREACHABLE_DEVICE = ErrorCode.UNREACHABLE_DEVICE: ERROR_CODE_UNREACHABLE_DEVICE indicates the device cannot be reached

UNSPECIFIED = ErrorCode.UNSPECIFIED: ERROR_CODE_UNSPECIFIED uninitialized value

name: str | None

value: int