imagestatus.v1

software_image_compliance_code is the compliance code for images.

terminattr_compliance_code is the compliance code for TerminAttr.

extensions_compliance_code is the compliance code for extensions.

values is the mapping of supervisor type to compliance code.

name is the name of the extension.

version is the version of the extension.

reboot_required indicates whether applying/deleting this extension

would result in a reboot.

present indicates whether the extension is present in the device

or not.

installed indicates whether the extension is installed, not

installed or force installed.

status_detail gives the details behind installation of the extension.

is_embedded indicates whether the extension is embedded in the EOS swi

or not.

code indicates the operation performed to get from one side of the diff

to the other.

a is the extension on the a side (left hand side).

b is the extension on the b side (right hand side).

values is an ordered list of extension diffs applied to the device.

values is the mapping of supervisor type to extension diff.

values represents extension information.

sku represents the name of the sku.

error_code is the error code.

error_msg provides a description of the error.

values is a list of image errors.

version is the version of the EOS image.

release is the release name of the EOS image.

flavor is the flavor information of the EOS image.

default flavor is DEFAULT. Other flavors can be DPE, 2GB, etc.

variant is the variant information of the EOS image.

possible values: INT or US.

arch is the architecture of the EOS image.

sku indicates the top-level sku or model number.

running_image_update_time is the most recent timestamp at which one of

running image side properties is updated.

designed_image_update_time is the most recent timestamp at which one of

designed image side properties is updated.

dual_sup indicates if a device is a dual supervisor.

active_slot indicates the physical slot number for the the active

supervisor.

standby_slot indicates the physical slot number for the standby

supervisor.

software_image_diff indicates the image diff for each supervisor.

terminattr_diff indicates the terminattr diff for each supervisor.

extensions_diff indicates the extension diff for each supervisor.

compliance_status is the aggregated compliance status (including both

active/standby and image/TA/extension compliance).

compliance provides compliance information for each supervisor.

reboot_required indicates whether a reboot is required if the designed

image is pushed to the device.

digest is the digest of the image summary. It can use SHA-256 hash

algorithm for example. It is computed by stringifying the

software_image_diff, terminattr_diff and extensions_diff and computing the

hash.

sku represents the name of the sku.

warning_code is the warning code.

warning_msg provides a description of the warning.

values is a list of image warnings.

software_image_reboot_required indicates whether reboot is required

for the software image being applied.

terminattr_reboot_required indicates whether reboot is required

for the terminattr being applied/deleted.

extension_reboot_required indicates whether reboot is required

for the extensions being applied/deleted.

name is the name of the EOS image.

version is the version of the EOS image.

metadata is the metadata of EOS image.

code indicates the operation performed to get from one side of the diff

to the other.

a is the software image on the a side (left hand side).

b is the software image on the b side (right hand side).

values is the mapping of supervisor type to image diff.

key represents the image summary key.

summary is the image diff summary.

errors are the image errors encountered while validating the image. These are

displayed on the change control review page (for changes made outside the workspace).

warnings are the image warnings encountered while validating the image. These are

displayed on the change control review page (for changes made outside the workspace).

device_id is the serial number of the device

values is the mapping of supervisor type to terminattr diff.

DIFF_OP_UNSPECIFIED indicates op code is unspecified.

DIFF_OP_NOP indicates no change.

DIFF_OP_ADD is an addition of a software.

DIFF_OP_DELETE is deletion of a software.

DIFF_OP_CHANGE is an update to the software.

ERROR_CODE_UNSPECIFIED indicates error code is unspecified.

ERROR_CODE_SUPPORT_NOT_INTRODUCED represents case where the given EOS version does

not support the SKU.

Deprecated - use ERROR_CODE_EOS_SUPPORT_NOT_INTRODUCED

ERROR_CODE_SUPPORT_REMOVED represents case where the given EOS version no longer

supports the SKU.

Deprecated - use ERROR_CODE_EOS_SUPPORT_REMOVED

ERROR_CODE_DEVICE_UNREACHABLE represents the case where the device

is unreachable during a compliance computation.

ERROR_CODE_VALIDATION_FAILED represents case where the validations checks

failed.

ERROR_CODE_GET_PROPOSED_IMAGE_INFO_FAILED represents case where we are

unable to get proposed image information for a device.

ERROR_CODE_GET_RUNNING_IMAGE_INFO_FROM_ACTIVE_SUPERVISOR_FAILED represents case where we

fail to get running image information from an active supervisor.

ERROR_CODE_GET_RUNNING_IMAGE_INFO_FROM_PEER_SUPERVISOR_FAILED represents case when we

fail to get information from peer supervisor.

ERROR_CODE_EOS_TA_ARCHITECTURE_INCOMPATIBLE represents the case where EOS architecture and

TerminAttr architecture are incompatible.

ERROR_CODE_TA_CV_INCOMPATIBLE represents the case where TerminAttr is incompatible with

CloudVision; i.e., the TerminAttr version is below CloudVision’s minimum supported version.

ERROR_CODE_EOS_CV_INCOMPATIBLE represents the case where the EOS version is incompatible with

CloudVision; i.e., the EOS version is outside of CloudVision’s supported range of versions.

ERROR_CODE_EOS_SUPPORT_NOT_INTRODUCED represents the case where the given EOS version does

not support the SKU.

ERROR_CODE_EOS_SUPPORT_REMOVED represents the case where the given EOS version no longer

supports the SKU.

ERROR_CODE_PHYSICAL_DEVICE_EOS_INCOMPATIBLE represents the case where the physical device

does not support the given EOS type.

ERROR_CODE_TA_EMBEDDEDEXT_INCOMPATIBLE represents the case where the extension TerminAttr

version is lower than the embedded TerminAttr version in SWI.

EXTENSION_INSTALL_STATUS_UNSPECIFIED indicates extensions install status is unspecified.

EXTENSION_INSTALL_STATUS_NOT_INSTALLED indicates extension is not installed on the device.

EXTENSION_INSTALL_STATUS_INSTALLED indicates extension is installed on the device.

EXTENSION_INSTALL_STATUS_FORCE_INSTALLED indicates extension is force installed on

device.

SOFTWARE_COMPLIANCE_CODE_UNSPECIFIED indicates compliance code is unspecified.

SOFTWARE_COMPLIANCE_CODE_IN_SYNC indicates designed and running images/extensions

are identical.

SOFTWARE_COMPLIANCE_CODE_OUT_OF_SYNC indicates designed and running images/extensions

are not identical.

WARNING_CODE_UNSPECIFIED indicates warning code is unspecified.

WARNING_CODE_NOT_APPLICABLE represents cases where EOS <-> SKU/TA compatibility

is not applicable for non physical switches like vEos.

WARNING_CODE_SKUINFO_UNAVAILABLE represents case where

information about certain skus is missing.

WARNING_CODE_DEVICE_SKU_UNAVAILABLE represents unavailability of skus for an EOS Device.

WARNING_CODE_SWI_UNKNOWN represents cases where EOS version is not found in release database.

WARNING_CODE_TA_EOS_INCOMPATIBLE represents cases where TA and EOS are not compatible.

TA is lower than embedded TA in swi or given TA is unsupported by the EOS.

WARNING_CODE_TA_CV_INCOMPATIBLE represents cases where TA is incompatible with CV.

TA is lower than minimum supported TA on CV.

Deprecated - use ERROR_CODE_TA_CV_INCOMPATIBLE.

WARNING_CODE_EOS_CV_INCOMPATIBLE represents cases where EOS is no longer or not yet

supported by CV. Given EOS is outside range of CV’s minimum and maximum EOS.

Deprecated - use ERROR_CODE_EOS_CV_INCOMPATIBLE.

WARNING_CODE_EOS_ARCH_UNKNOWN represents cases where the specified architecture is

not valid for EOS.

WARNING_CODE_TA_EMBEDDEDEXT_INCOMPATIBLE represents cases where TA extension is lower

in version than embedded TA in SWI.

WARNING_CODE_ARCH_INCOMPATIBLE represents cases where EOS arch and TA arch are

different. Deprecated.

WARNING_CODE_EOS_END_OF_LIFE_DATE_PASSED represents cases where the given EOS has passed

its end of life date.

WARNING_CODE_SUPPORT_NOT_INTRODUCED represents cases where the given EOS version does

not support the SKUs.

WARNING_CODE_SUPPORT_REMOVED represents cases where the given EOS version no longer

supports the SKUs.

WARNING_CODE_RUNNING_TA_BELOW_MIN_SUPPORTED_VERSION represents cases where the running

TerminAttr version is below CloudVision’s minimum supported version.

Key uniquely identifies a Summary instance to retrieve.

This value must be populated.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Time carries the (UTC) timestamp of the last-modification of the

Summary instance in this response.

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each Summary at end.

* Each Summary response is fully-specified (all fields set).

* start: Returns the state of each Summary at start, followed by updates until now.

* Each Summary response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each Summary at start, followed by updates

until end.

* Each Summary response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

Time holds the timestamp of this Summary’s last modification.

Operation indicates how the Summary value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.