cloudvision.api.arista.imagestatus.v1 package

Module contents

class cloudvision.api.arista.imagestatus.v1.ComplianceStatus(software_image_compliance_code: ~cloudvision.api.arista.imagestatus.v1.SoftwareComplianceCode = <PLACEHOLDER>, terminattr_compliance_code: ~cloudvision.api.arista.imagestatus.v1.SoftwareComplianceCode = <PLACEHOLDER>, extensions_compliance_code: ~cloudvision.api.arista.imagestatus.v1.SoftwareComplianceCode = <PLACEHOLDER>)[source]

Bases: Message

ComplianceStatus indicates compliance status for software image, terminattr and extensions.

extensions_compliance_code: SoftwareComplianceCode = <PLACEHOLDER>: extensions_compliance_code is the compliance code for extensions.

software_image_compliance_code: SoftwareComplianceCode = <PLACEHOLDER>: software_image_compliance_code is the compliance code for images.

terminattr_compliance_code: SoftwareComplianceCode = <PLACEHOLDER>: terminattr_compliance_code is the compliance code for TerminAttr.

class cloudvision.api.arista.imagestatus.v1.ComplianceStatusBySup(values: ~typing.Dict[str, ~cloudvision.api.arista.imagestatus.v1.ComplianceStatus] = <PLACEHOLDER>)[source]

Bases: Message

ComplianceStatusBySup is a map that indicates the compliance code for each supervisor.

values: Dict[str, ComplianceStatus] = <PLACEHOLDER>: values is the mapping of supervisor type to compliance code.

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

Bases: Enum

DiffOp represents the operation performed to get from one side of the diff to the other.

ADD = DiffOp.ADD: DIFF_OP_ADD is an addition of a software.

CHANGE = DiffOp.CHANGE: DIFF_OP_CHANGE is an update to the software.

DELETE = DiffOp.DELETE: DIFF_OP_DELETE is deletion of a software.

NOP = DiffOp.NOP: DIFF_OP_NOP indicates no change.

UNSPECIFIED = DiffOp.UNSPECIFIED: DIFF_OP_UNSPECIFIED indicates op code is unspecified.

name: str | None

value: int

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

Bases: Enum

ErrorCode indicates errors produced during image validations.

ARCH_UNSUPPORTED = ErrorCode.ARCH_UNSUPPORTED: ERROR_CODE_ARCH_UNSUPPORTED represents the case where the given image architecture is not supported by CloudVision.

DEVICE_EOS_2GB_INCOMPATIBLE = ErrorCode.DEVICE_EOS_2GB_INCOMPATIBLE: ERROR_CODE_DEVICE_EOS_2GB_INCOMPATIBLE represents the case where a 2GB-device is incompatible with a non-2GB EOS or a non-2GB device is incompatible with a 2GB-EOS.

DEVICE_UNREACHABLE = ErrorCode.DEVICE_UNREACHABLE: ERROR_CODE_DEVICE_UNREACHABLE represents the case where the device is unreachable during a compliance computation.

EOS_CV_INCOMPATIBLE = ErrorCode.EOS_CV_INCOMPATIBLE: ERROR_CODE_EOS_CV_INCOMPATIBLE represents the case where EOS is not supported by CV. The given EOS is below CV’s minimum supported EOS version.

EOS_EXTENSION_VERSION_INCOMPATIBLE = ErrorCode.EOS_EXTENSION_VERSION_INCOMPATIBLE: ERROR_CODE_EOS_EXTENSION_VERSION_INCOMPATIBLE represents the case where the given extension version doesn’t support the given EOS version.

EOS_SUPPORT_NOT_INTRODUCED = ErrorCode.EOS_SUPPORT_NOT_INTRODUCED: ERROR_CODE_EOS_SUPPORT_NOT_INTRODUCED represents the case where the given EOS version does not support the SKU.

EOS_SUPPORT_REMOVED = ErrorCode.EOS_SUPPORT_REMOVED: ERROR_CODE_EOS_SUPPORT_REMOVED represents the case where the given EOS version no longer supports the SKU.

EOS_TA_ARCHITECTURE_INCOMPATIBLE = ErrorCode.EOS_TA_ARCHITECTURE_INCOMPATIBLE: ERROR_CODE_EOS_TA_ARCHITECTURE_INCOMPATIBLE represents the case where EOS architecture and TerminAttr architecture are incompatible.

GET_PROPOSED_IMAGE_INFO_FAILED = ErrorCode.GET_PROPOSED_IMAGE_INFO_FAILED: ERROR_CODE_GET_PROPOSED_IMAGE_INFO_FAILED represents case where we are unable to get proposed image information for a device.

GET_RUNNING_IMAGE_INFO_FROM_ACTIVE_SUPERVISOR_FAILED = ErrorCode.GET_RUNNING_IMAGE_INFO_FROM_ACTIVE_SUPERVISOR_FAILED: ERROR_CODE_GET_RUNNING_IMAGE_INFO_FROM_ACTIVE_SUPERVISOR_FAILED represents case where we fail to get running image information from an active supervisor.

GET_RUNNING_IMAGE_INFO_FROM_PEER_SUPERVISOR_FAILED = ErrorCode.GET_RUNNING_IMAGE_INFO_FROM_PEER_SUPERVISOR_FAILED: ERROR_CODE_GET_RUNNING_IMAGE_INFO_FROM_PEER_SUPERVISOR_FAILED represents case when we fail to get information from peer supervisor.

PHYSICAL_DEVICE_EOS_INCOMPATIBLE = ErrorCode.PHYSICAL_DEVICE_EOS_INCOMPATIBLE: ERROR_CODE_PHYSICAL_DEVICE_EOS_INCOMPATIBLE represents the case where the physical device does not support the given EOS type.

SUPPORT_NOT_INTRODUCED = ErrorCode.SUPPORT_NOT_INTRODUCED: 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

SUPPORT_REMOVED = ErrorCode.SUPPORT_REMOVED: ERROR_CODE_SUPPORT_REMOVED represents case where the given EOS version no longer supports the SKU. Deprecated - use ERROR_CODE_EOS_SUPPORT_REMOVED

TA_CV_INCOMPATIBLE = ErrorCode.TA_CV_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.

TA_EMBEDDEDEXT_INCOMPATIBLE = ErrorCode.TA_EMBEDDEDEXT_INCOMPATIBLE: ERROR_CODE_TA_EMBEDDEDEXT_INCOMPATIBLE represents the case where the extension TerminAttr version is lower than the embedded TerminAttr version in SWI.

UNSPECIFIED = ErrorCode.UNSPECIFIED: ERROR_CODE_UNSPECIFIED indicates error code is unspecified.

VALIDATION_FAILED = ErrorCode.VALIDATION_FAILED: ERROR_CODE_VALIDATION_FAILED represents case where the validations checks failed.

name: str | None

value: int

class cloudvision.api.arista.imagestatus.v1.Extension(name: str | None = <PLACEHOLDER>, version: str | None = <PLACEHOLDER>, reboot_required: bool | None = <PLACEHOLDER>, present: bool | None = <PLACEHOLDER>, installed: ~cloudvision.api.arista.imagestatus.v1.ExtensionInstallStatus = <PLACEHOLDER>, status_detail: str | None = <PLACEHOLDER>, is_embedded: bool | None = <PLACEHOLDER>, arch: str | None = <PLACEHOLDER>)[source]

Bases: Message

Extension provides information of the running/designed extensions.

arch: str | None = <PLACEHOLDER>: arch is architecture type of the extension.

installed: ExtensionInstallStatus = <PLACEHOLDER>: installed indicates whether the extension is installed, not installed or force installed.

is_embedded: bool | None = <PLACEHOLDER>: is_embedded indicates whether the extension is embedded in the EOS swi or not.

name: str | None = <PLACEHOLDER>: name is the name of the extension.

present: bool | None = <PLACEHOLDER>: present indicates whether the extension is present in the device or not.

reboot_required: bool | None = <PLACEHOLDER>: reboot_required indicates whether applying/deleting this extension would result in a reboot.

status_detail: str | None = <PLACEHOLDER>: status_detail gives the details behind installation of the extension.

version: str | None = <PLACEHOLDER>: version is the version of the extension.

class cloudvision.api.arista.imagestatus.v1.ExtensionDiff(code: ~cloudvision.api.arista.imagestatus.v1.DiffOp = <PLACEHOLDER>, a: ~cloudvision.api.arista.imagestatus.v1.Extension = <PLACEHOLDER>, b: ~cloudvision.api.arista.imagestatus.v1.Extension = <PLACEHOLDER>, text_code: ~cloudvision.api.arista.imagestatus.v1.DiffOp = <PLACEHOLDER>)[source]

Bases: Message

ExtensionDiff is the diff for the running/designed extensions.

a: Extension = <PLACEHOLDER>: a is the extension on the a side (left hand side).

b: Extension = <PLACEHOLDER>: b is the extension on the b side (right hand side).

code: DiffOp = <PLACEHOLDER>: code indicates the operation performed to get from one side of the diff to the other.

text_code: DiffOp = <PLACEHOLDER>: text_code is the color in the diff view page.

class cloudvision.api.arista.imagestatus.v1.ExtensionDiffs(values: ~typing.List[~cloudvision.api.arista.imagestatus.v1.ExtensionDiff] = <PLACEHOLDER>)[source]

Bases: Message

ExtensionDiffs is a list of extension diff information in the order they will be applied.

values: List[ExtensionDiff] = <PLACEHOLDER>: values is an ordered list of extension diffs applied to the device.

class cloudvision.api.arista.imagestatus.v1.ExtensionDiffsBySup(values: ~typing.Dict[str, ~cloudvision.api.arista.imagestatus.v1.ExtensionDiffs] = <PLACEHOLDER>)[source]

Bases: Message

ExtensionDiffsBySup is the extension diff information for each supervisor.

values: Dict[str, ExtensionDiffs] = <PLACEHOLDER>: values is the mapping of supervisor type to extension diff.

class cloudvision.api.arista.imagestatus.v1.ExtensionInstallStatus(value: int)[source]

Bases: Enum

ExtensionInstallStatus indicates whether an extension is installed, not installed or force installed.

FORCE_INSTALLED = ExtensionInstallStatus.FORCE_INSTALLED: EXTENSION_INSTALL_STATUS_FORCE_INSTALLED indicates extension is force installed on device.

INSTALLED = ExtensionInstallStatus.INSTALLED: EXTENSION_INSTALL_STATUS_INSTALLED indicates extension is installed on the device.

NOT_INSTALLED = ExtensionInstallStatus.NOT_INSTALLED: EXTENSION_INSTALL_STATUS_NOT_INSTALLED indicates extension is not installed on the device.

UNSPECIFIED = ExtensionInstallStatus.UNSPECIFIED: EXTENSION_INSTALL_STATUS_UNSPECIFIED indicates extensions install status is unspecified.

name: str | None

value: int

class cloudvision.api.arista.imagestatus.v1.Extensions(values: ~typing.List[~cloudvision.api.arista.imagestatus.v1.Extension] = <PLACEHOLDER>)[source]

Bases: Message

Extensions provides an ordered list of running/designed extensions.

values: List[Extension] = <PLACEHOLDER>: values represents extension information.

class cloudvision.api.arista.imagestatus.v1.ImageError(sku: str | None = <PLACEHOLDER>, error_code: ~cloudvision.api.arista.imagestatus.v1.ErrorCode = <PLACEHOLDER>, error_msg: str | None = <PLACEHOLDER>)[source]

Bases: Message

ImageError wraps ErrorCode enum with a reason string.

error_code: ErrorCode = <PLACEHOLDER>: error_code is the error code.

error_msg: str | None = <PLACEHOLDER>: error_msg provides a description of the error.

sku: str | None = <PLACEHOLDER>: sku represents the name of the sku.

class cloudvision.api.arista.imagestatus.v1.ImageErrors(values: ~typing.List[~cloudvision.api.arista.imagestatus.v1.ImageError] = <PLACEHOLDER>)[source]

Bases: Message

ImageErrors is the list of errors reported by CVP when handling image validations.

values: List[ImageError] = <PLACEHOLDER>: values is a list of image errors.

class cloudvision.api.arista.imagestatus.v1.ImageInfo(sku: str | None = <PLACEHOLDER>, info_code: ~cloudvision.api.arista.imagestatus.v1.InfoCode = <PLACEHOLDER>, info_msg: str | None = <PLACEHOLDER>)[source]

Bases: Message

ImageInfo wraps InfoCode enum with a reason string.

info_code: InfoCode = <PLACEHOLDER>: info_code is the info code.

info_msg: str | None = <PLACEHOLDER>: info_msg provides a description of the info.

sku: str | None = <PLACEHOLDER>: sku represents the name of the sku.

class cloudvision.api.arista.imagestatus.v1.ImageInfos(values: ~typing.List[~cloudvision.api.arista.imagestatus.v1.ImageInfo] = <PLACEHOLDER>)[source]

Bases: Message

ImageInfos is the list of info messages reported by CVP when handling image validations.

values: List[ImageInfo] = <PLACEHOLDER>: values is a list of image infos.

class cloudvision.api.arista.imagestatus.v1.ImageMetadata(version: str | None = <PLACEHOLDER>, release: str | None = <PLACEHOLDER>, flavor: str | None = <PLACEHOLDER>, variant: str | None = <PLACEHOLDER>, arch: str | None = <PLACEHOLDER>)[source]

Bases: Message

ImageMetadata provides information regarding the software image.

arch: str | None = <PLACEHOLDER>: arch is the architecture of the EOS image.

flavor: str | None = <PLACEHOLDER>: flavor is the flavor information of the EOS image. default flavor is DEFAULT. Other flavors can be DPE, 2GB, etc.

release: str | None = <PLACEHOLDER>: release is the release name of the EOS image.

variant: str | None = <PLACEHOLDER>: variant is the variant information of the EOS image. possible values: INT or US.

version: str | None = <PLACEHOLDER>: version is the version of the EOS image.

class cloudvision.api.arista.imagestatus.v1.ImageSummary(sku: str | None = <PLACEHOLDER>, running_image_update_time: ~datetime.datetime = <PLACEHOLDER>, designed_image_update_time: ~datetime.datetime = <PLACEHOLDER>, dual_sup: bool | None = <PLACEHOLDER>, active_slot: int | None = <PLACEHOLDER>, standby_slot: int | None = <PLACEHOLDER>, software_image_diff: ~cloudvision.api.arista.imagestatus.v1.SoftwareImageDiffsBySup = <PLACEHOLDER>, terminattr_diff: ~cloudvision.api.arista.imagestatus.v1.TerminAttrDiffsBySup = <PLACEHOLDER>, extensions_diff: ~cloudvision.api.arista.imagestatus.v1.ExtensionDiffsBySup = <PLACEHOLDER>, compliance_status: ~cloudvision.api.arista.imagestatus.v1.SoftwareComplianceCode = <PLACEHOLDER>, compliance: ~cloudvision.api.arista.imagestatus.v1.ComplianceStatusBySup = <PLACEHOLDER>, reboot_required: ~cloudvision.api.arista.imagestatus.v1.RebootRequired = <PLACEHOLDER>, digest: str | None = <PLACEHOLDER>)[source]

Bases: Message

ImageSummary represents device image summary.

active_slot: int | None = <PLACEHOLDER>: active_slot indicates the physical slot number for the the active supervisor.

compliance: ComplianceStatusBySup = <PLACEHOLDER>: compliance provides compliance information for each supervisor.

compliance_status: SoftwareComplianceCode = <PLACEHOLDER>: compliance_status is the aggregated compliance status (including both active/standby and image/TA/extension compliance).

designed_image_update_time: datetime = <PLACEHOLDER>: designed_image_update_time is the most recent timestamp at which one of designed image side properties is updated.

digest: str | None = <PLACEHOLDER>: 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.

dual_sup: bool | None = <PLACEHOLDER>: dual_sup indicates if a device is a dual supervisor.

extensions_diff: ExtensionDiffsBySup = <PLACEHOLDER>: extensions_diff indicates the extension diff for each supervisor.

reboot_required: RebootRequired = <PLACEHOLDER>: reboot_required indicates whether a reboot is required if the designed image is pushed to the device.

running_image_update_time: datetime = <PLACEHOLDER>: running_image_update_time is the most recent timestamp at which one of running image side properties is updated.

sku: str | None = <PLACEHOLDER>: sku indicates the top-level sku or model number.

software_image_diff: SoftwareImageDiffsBySup = <PLACEHOLDER>: software_image_diff indicates the image diff for each supervisor.

standby_slot: int | None = <PLACEHOLDER>: standby_slot indicates the physical slot number for the standby supervisor.

terminattr_diff: TerminAttrDiffsBySup = <PLACEHOLDER>: terminattr_diff indicates the terminattr diff for each supervisor.

class cloudvision.api.arista.imagestatus.v1.ImageWarning(sku: str | None = <PLACEHOLDER>, warning_code: ~cloudvision.api.arista.imagestatus.v1.WarningCode = <PLACEHOLDER>, warning_msg: str | None = <PLACEHOLDER>)[source]

Bases: Message

ImageWarning wraps WarningCode enum with a reason string.

sku: str | None = <PLACEHOLDER>: sku represents the name of the sku.

warning_code: WarningCode = <PLACEHOLDER>: warning_code is the warning code.

warning_msg: str | None = <PLACEHOLDER>: warning_msg provides a description of the warning.

class cloudvision.api.arista.imagestatus.v1.ImageWarnings(values: ~typing.List[~cloudvision.api.arista.imagestatus.v1.ImageWarning] = <PLACEHOLDER>)[source]

Bases: Message

ImageWarnings is the list of warnings reported by CVP when handling image validations.

values: List[ImageWarning] = <PLACEHOLDER>: values is a list of image warnings.

class cloudvision.api.arista.imagestatus.v1.InfoCode(value: int)[source]

Bases: Enum

InfoCode indicates info messages produced during image validations.

NEWER_VERSION_AVAILABLE = InfoCode.NEWER_VERSION_AVAILABLE: INFO_CODE_NEWER_VERSION_AVAILABLE represents cases where a newer EOS maintainance release is available for download.

UNIVERSAL_IMAGE_ARCH_APPLIED = InfoCode.UNIVERSAL_IMAGE_ARCH_APPLIED: INFO_CODE_UNIVERSAL_IMAGE_ARCH_APPLIED represents cases where a specific architecture is picked for a Universal (multiarch) EOS image.

UNSPECIFIED = InfoCode.UNSPECIFIED: INFO_CODE_UNSPECIFIED indicates info code is unspecified.

name: str | None

value: int

class cloudvision.api.arista.imagestatus.v1.MetaResponse(time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>, count: int | None = <PLACEHOLDER>)[source]

Bases: Message

count: int | None = <PLACEHOLDER>: Count is the number of items present under the conditions of the request.

time: datetime = <PLACEHOLDER>: Time holds the timestamp of the last item included in the metadata calculation.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the 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.

class cloudvision.api.arista.imagestatus.v1.RebootRequired(software_image_reboot_required: bool | None = <PLACEHOLDER>, terminattr_reboot_required: bool | None = <PLACEHOLDER>, extension_reboot_required: bool | None = <PLACEHOLDER>)[source]

Bases: Message

RebootRequired indicates the reboot information per software image, terminattr and extension for the switch as a whole.

extension_reboot_required: bool | None = <PLACEHOLDER>: extension_reboot_required indicates whether reboot is required for the extensions being applied/deleted.

software_image_reboot_required: bool | None = <PLACEHOLDER>: software_image_reboot_required indicates whether reboot is required for the software image being applied.

terminattr_reboot_required: bool | None = <PLACEHOLDER>: terminattr_reboot_required indicates whether reboot is required for the terminattr being applied/deleted.

class cloudvision.api.arista.imagestatus.v1.SoftwareComplianceCode(value: int)[source]

Bases: Enum

SoftwareComplianceCode indicates possible compliance status.

IN_SYNC = SoftwareComplianceCode.IN_SYNC: SOFTWARE_COMPLIANCE_CODE_IN_SYNC indicates designed and running images/extensions are identical.

OUT_OF_SYNC = SoftwareComplianceCode.OUT_OF_SYNC: SOFTWARE_COMPLIANCE_CODE_OUT_OF_SYNC indicates designed and running images/extensions are not identical.

UNSPECIFIED = SoftwareComplianceCode.UNSPECIFIED: SOFTWARE_COMPLIANCE_CODE_UNSPECIFIED indicates compliance code is unspecified.

name: str | None

value: int

class cloudvision.api.arista.imagestatus.v1.SoftwareImage(name: str | None = <PLACEHOLDER>, version: str | None = <PLACEHOLDER>, metadata: ~cloudvision.api.arista.imagestatus.v1.ImageMetadata = <PLACEHOLDER>)[source]

Bases: Message

SoftwareImage provides information of the running/designed EOS image.

metadata: ImageMetadata = <PLACEHOLDER>: metadata is the metadata of EOS image.

name: str | None = <PLACEHOLDER>: name is the name of the EOS image.

version: str | None = <PLACEHOLDER>: version is the version of the EOS image.

class cloudvision.api.arista.imagestatus.v1.SoftwareImageDiff(code: ~cloudvision.api.arista.imagestatus.v1.DiffOp = <PLACEHOLDER>, a: ~cloudvision.api.arista.imagestatus.v1.SoftwareImage = <PLACEHOLDER>, b: ~cloudvision.api.arista.imagestatus.v1.SoftwareImage = <PLACEHOLDER>, text_code: ~cloudvision.api.arista.imagestatus.v1.DiffOp = <PLACEHOLDER>)[source]

Bases: Message

SoftwareImageDiff is the diff for the running/designed images.

a: SoftwareImage = <PLACEHOLDER>: a is the software image on the a side (left hand side).

b: SoftwareImage = <PLACEHOLDER>: b is the software image on the b side (right hand side).

code: DiffOp = <PLACEHOLDER>: code indicates the operation performed to get from one side of the diff to the other.

text_code: DiffOp = <PLACEHOLDER>: text_code is the color in the diff view page.

class cloudvision.api.arista.imagestatus.v1.SoftwareImageDiffsBySup(values: ~typing.Dict[str, ~cloudvision.api.arista.imagestatus.v1.SoftwareImageDiff] = <PLACEHOLDER>)[source]

Bases: Message

SoftwareImageDiffsBySup is software image diff information for each supervisor.

values: Dict[str, SoftwareImageDiff] = <PLACEHOLDER>: values is the mapping of supervisor type to image diff.

class cloudvision.api.arista.imagestatus.v1.Summary(key: ~cloudvision.api.arista.imagestatus.v1.SummaryKey = <PLACEHOLDER>, summary: ~cloudvision.api.arista.imagestatus.v1.ImageSummary = <PLACEHOLDER>, errors: ~cloudvision.api.arista.imagestatus.v1.ImageErrors = <PLACEHOLDER>, warnings: ~cloudvision.api.arista.imagestatus.v1.ImageWarnings = <PLACEHOLDER>, infos: ~cloudvision.api.arista.imagestatus.v1.ImageInfos = <PLACEHOLDER>)[source]

Bases: Message

Summary represents the device image summary.

errors: ImageErrors = <PLACEHOLDER>: errors are the image errors encountered while validating the image. These are displayed on the workspace build results page.

infos: ImageInfos = <PLACEHOLDER>: infos are the image infos encountered while validating the image. These are displayed on the workspace build results page.

key: SummaryKey = <PLACEHOLDER>: key represents the image summary key.

summary: ImageSummary = <PLACEHOLDER>: summary is the image diff summary.

warnings: ImageWarnings = <PLACEHOLDER>: warnings are the image warnings encountered while validating the image. These are displayed on the workspace build results page.

class cloudvision.api.arista.imagestatus.v1.SummaryBatchedStreamRequest(partial_eq_filter: List[ForwardRef('Summary')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

Bases: Message

max_messages: int | None = <PLACEHOLDER>: MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

partial_eq_filter: List[Summary] = <PLACEHOLDER>

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.

time: __time__.TimeBounds = <PLACEHOLDER>

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.

class cloudvision.api.arista.imagestatus.v1.SummaryBatchedStreamResponse(responses: List[ForwardRef('SummaryStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[SummaryStreamResponse] = <PLACEHOLDER>: Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT).

class cloudvision.api.arista.imagestatus.v1.SummaryKey(device_id: str | None = <PLACEHOLDER>)[source]

Bases: Message

SummaryKey uniquely identifies a device summary request.

device_id: str | None = <PLACEHOLDER>: device_id is the serial number of the device

class cloudvision.api.arista.imagestatus.v1.SummaryRequest(key: 'SummaryKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: SummaryKey = <PLACEHOLDER>: Key uniquely identifies a Summary instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>: 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.

class cloudvision.api.arista.imagestatus.v1.SummaryResponse(value: 'Summary' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the Summary instance in this response.

value: Summary = <PLACEHOLDER>: 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.

class cloudvision.api.arista.imagestatus.v1.SummaryServiceBase[source]

Bases: ServiceBase

async get_all(summary_stream_request: SummaryStreamRequest) → AsyncIterator[SummaryStreamResponse][source]

async get_all_batched(summary_batched_stream_request: SummaryBatchedStreamRequest) → AsyncIterator[SummaryBatchedStreamResponse][source]

async get_meta(summary_stream_request: SummaryStreamRequest) → MetaResponse[source]

async get_one(summary_request: SummaryRequest) → SummaryResponse[source]

async get_some(summary_some_request: SummarySomeRequest) → AsyncIterator[SummarySomeResponse][source]

async subscribe(summary_stream_request: SummaryStreamRequest) → AsyncIterator[SummaryStreamResponse][source]

async subscribe_batched(summary_batched_stream_request: SummaryBatchedStreamRequest) → AsyncIterator[SummaryBatchedStreamResponse][source]

async subscribe_meta(summary_stream_request: SummaryStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(summary_stream_request: SummaryStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SummaryStreamResponse][source]

async get_all_batched(summary_batched_stream_request: SummaryBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SummaryBatchedStreamResponse][source]

async get_meta(summary_stream_request: SummaryStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(summary_request: SummaryRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → SummaryResponse[source]

async get_some(summary_some_request: SummarySomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SummarySomeResponse][source]

async subscribe(summary_stream_request: SummaryStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SummaryStreamResponse][source]

async subscribe_batched(summary_batched_stream_request: SummaryBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SummaryBatchedStreamResponse][source]

async subscribe_meta(summary_stream_request: SummaryStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.imagestatus.v1.SummarySomeRequest(keys: List[ForwardRef('SummaryKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[SummaryKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>: 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.

class cloudvision.api.arista.imagestatus.v1.SummarySomeResponse(value: 'Summary' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: Error is an optional field. It should be filled when there is an error in the GetSome process.

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the Summary instance in this response.

value: Summary = <PLACEHOLDER>: 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.

class cloudvision.api.arista.imagestatus.v1.SummaryStreamRequest(partial_eq_filter: List[ForwardRef('Summary')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[Summary] = <PLACEHOLDER>

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.

time: __time__.TimeBounds = <PLACEHOLDER>

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.

class cloudvision.api.arista.imagestatus.v1.SummaryStreamResponse(value: 'Summary' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this Summary’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: 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.

value: Summary = <PLACEHOLDER>: 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.

class cloudvision.api.arista.imagestatus.v1.TerminAttrDiffsBySup(values: ~typing.Dict[str, ~cloudvision.api.arista.imagestatus.v1.ExtensionDiff] = <PLACEHOLDER>)[source]

Bases: Message

TerminAttrDiffsBySup is the terminattr diff information for each supervisor.

values: Dict[str, ExtensionDiff] = <PLACEHOLDER>: values is the mapping of supervisor type to terminattr diff.

class cloudvision.api.arista.imagestatus.v1.WarningCode(value: int)[source]

Bases: Enum

WarningCode indicates warnings produced during image validations.

ARCH_INCOMPATIBLE = WarningCode.ARCH_INCOMPATIBLE: WARNING_CODE_ARCH_INCOMPATIBLE represents cases where EOS arch and TA arch are different. Deprecated.

BUGALERTS_DATA_MISSING = WarningCode.BUGALERTS_DATA_MISSING: WARNING_CODE_BUGALERTS_DATA_MISSING represents cases where some of the BugAlerts data under Aeris analytics dataset is missing.

DEVICE_SKU_UNAVAILABLE = WarningCode.DEVICE_SKU_UNAVAILABLE: WARNING_CODE_DEVICE_SKU_UNAVAILABLE represents unavailability of skus for an EOS Device.

EOS_ARCH_UNKNOWN = WarningCode.EOS_ARCH_UNKNOWN: WARNING_CODE_EOS_ARCH_UNKNOWN represents cases where the specified architecture is not valid for EOS.

EOS_CV_INCOMPATIBLE = WarningCode.EOS_CV_INCOMPATIBLE: WARNING_CODE_EOS_CV_INCOMPATIBLE represents the case where EOS is not yet supported by CV. The given EOS exceeds CV’s maximum supported EOS version.

EOS_END_OF_LIFE_DATE_PASSED = WarningCode.EOS_END_OF_LIFE_DATE_PASSED: WARNING_CODE_EOS_END_OF_LIFE_DATE_PASSED represents cases where the given EOS has passed its end of life date.

NOT_APPLICABLE = WarningCode.NOT_APPLICABLE: WARNING_CODE_NOT_APPLICABLE represents cases where EOS < - > SKU/TA compatibility is not applicable for non physical switches like vEos.

RUNNING_TA_BELOW_MIN_SUPPORTED_VERSION = WarningCode.RUNNING_TA_BELOW_MIN_SUPPORTED_VERSION: WARNING_CODE_RUNNING_TA_BELOW_MIN_SUPPORTED_VERSION represents cases where the running TerminAttr version is below CloudVision’s minimum supported version.

SKUINFO_UNAVAILABLE = WarningCode.SKUINFO_UNAVAILABLE: WARNING_CODE_SKUINFO_UNAVAILABLE represents case where information about certain skus is missing.

SUPPORT_NOT_INTRODUCED = WarningCode.SUPPORT_NOT_INTRODUCED: WARNING_CODE_SUPPORT_NOT_INTRODUCED represents cases where the given EOS version does not support the SKUs.

SUPPORT_REMOVED = WarningCode.SUPPORT_REMOVED: WARNING_CODE_SUPPORT_REMOVED represents cases where the given EOS version no longer supports the SKUs.

SWI_UNKNOWN = WarningCode.SWI_UNKNOWN: WARNING_CODE_SWI_UNKNOWN represents cases where EOS version is not found in release database.

TA_CV_INCOMPATIBLE = WarningCode.TA_CV_INCOMPATIBLE: 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.

TA_EMBEDDEDEXT_INCOMPATIBLE = WarningCode.TA_EMBEDDEDEXT_INCOMPATIBLE: WARNING_CODE_TA_EMBEDDEDEXT_INCOMPATIBLE represents cases where TA extension is lower in version than embedded TA in SWI.

TA_EOS_INCOMPATIBLE = WarningCode.TA_EOS_INCOMPATIBLE: 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.

TA_STUDIO_INCOMPATIBLE = WarningCode.TA_STUDIO_INCOMPATIBLE: WARNING_CODE_TA_STUDIO_INCOMPATIBLE represents cases where the TerminAttr is incompatible with Software Management Studio.

UNSPECIFIED = WarningCode.UNSPECIFIED: WARNING_CODE_UNSPECIFIED indicates warning code is unspecified.

name: str | None

value: int