cloudvision.compliance.async.compliancecheck package

Module contents

class cloudvision.compliance.async.compliancecheck.ComplianceBase

Bases: ServiceBase

Compliance provides configuration and image compliance information. To get the current view of an entity, leave the timestamp field unset in the corresponding request.

async config_diff_raw(config_diff_raw_request_iterator: ~typing.AsyncIterator[~cloudvision.compliance.async.compliancecheck.ConfigDiffRawRequest]) → ConfigDiffRawResponse]

async get_config(get_config_request: GetConfigRequest) → GetConfigResponse]

async get_config_diff(get_config_diff_request: GetConfigDiffRequest) → GetConfigDiffResponse]

async get_config_diff_for_task(get_config_diff_for_task_request: GetConfigDiffForTaskRequest) → GetConfigDiffForTaskResponse]

async get_config_diff_summary(get_config_diff_summary_request: GetConfigDiffSummaryRequest) → GetConfigDiffSummaryResponse]

async get_config_diff_summary_for_task(get_config_diff_summary_for_task_request: GetConfigDiffSummaryForTaskRequest) → GetConfigDiffSummaryForTaskResponse]

async get_device_status(get_device_status_request: GetDeviceStatusRequest) → GetDeviceStatusResponse]

async get_image_diff(get_image_diff_request: GetImageDiffRequest) → GetImageDiffResponse]

async get_image_diff_for_task(get_image_diff_for_task_request: GetImageDiffForTaskRequest) → GetImageDiffForTaskResponse]

async get_image_diff_v2(get_image_diff_request_v2: GetImageDiffRequestV2) → GetImageDiffResponseV2]

async get_image_diff_v3(get_image_diff_request_v3: GetImageDiffRequestV3) → GetImageDiffResponseV3]

async get_proposed_config(get_proposed_config_request: GetProposedConfigRequest) → GetProposedConfigResponse]

class cloudvision.compliance.async.compliancecheck.ComplianceStatus(software_image_compliance_code: SoftwareComplianceCode = <PLACEHOLDER>, terminattr_compliance_code: SoftwareComplianceCode = <PLACEHOLDER>, extensions_compliance_code: SoftwareComplianceCode = <PLACEHOLDER>)

Bases: Message

ComplianceStatus indicates the compliance status for a 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 software images.

terminattr_compliance_code: SoftwareComplianceCode = <PLACEHOLDER>

terminattr_compliance_code is the compliance code for TerminAttr.

class cloudvision.compliance.async.compliancecheck.ComplianceStatusBySup(values: Dict[str, ~cloudvision.compliance.async.compliancecheck.ComplianceStatus]=<PLACEHOLDER>)

Bases: Message

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

values: ComplianceStatus] = <PLACEHOLDER>

values is the mapping of supervisor type to compliance code.

class cloudvision.compliance.async.compliancecheck.ComplianceStub(channel: Channel, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: Mapping[str, str | bytes] | Collection[Tuple[str, str | bytes]] | None = None)

Bases: ServiceStub

Compliance provides configuration and image compliance information. To get the current view of an entity, leave the timestamp field unset in the corresponding request.

async config_diff_raw(config_diff_raw_request_iterator: AsyncIterable[ConfigDiffRawRequest] | Iterable[ConfigDiffRawRequest], *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigDiffRawResponse]

async get_config(get_config_request: GetConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[GetConfigResponse]

async get_config_diff(get_config_diff_request: GetConfigDiffRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[GetConfigDiffResponse]

async get_config_diff_for_task(get_config_diff_for_task_request: GetConfigDiffForTaskRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[GetConfigDiffForTaskResponse]

async get_config_diff_summary(get_config_diff_summary_request: GetConfigDiffSummaryRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[GetConfigDiffSummaryResponse]

async get_config_diff_summary_for_task(get_config_diff_summary_for_task_request: GetConfigDiffSummaryForTaskRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[GetConfigDiffSummaryForTaskResponse]

async get_device_status(get_device_status_request: GetDeviceStatusRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[GetDeviceStatusResponse]

async get_image_diff(get_image_diff_request: GetImageDiffRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[GetImageDiffResponse]

async get_image_diff_for_task(get_image_diff_for_task_request: GetImageDiffForTaskRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[GetImageDiffForTaskResponse]

async get_image_diff_v2(get_image_diff_request_v2: GetImageDiffRequestV2, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[GetImageDiffResponseV2]

async get_image_diff_v3(get_image_diff_request_v3: GetImageDiffRequestV3, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[GetImageDiffResponseV3]

async get_proposed_config(get_proposed_config_request: GetProposedConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[GetProposedConfigResponse]

class cloudvision.compliance.async.compliancecheck.ConfigDiff(entries: List[ForwardRef('DiffEntry')] = <PLACEHOLDER>)

Bases: Message

entries: DiffEntry] = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.ConfigDiffRawRequest(lhs: str = <PLACEHOLDER>, rhs: str = <PLACEHOLDER>, device_id: str = <PLACEHOLDER>, reconcile_all: bool = <PLACEHOLDER>, exclude_reconciled_managed_config: bool = <PLACEHOLDER>)

Bases: Message

device_id: str = <PLACEHOLDER>

exclude_reconciled_managed_config: bool = <PLACEHOLDER>

lhs: str = <PLACEHOLDER>

reconcile_all: bool = <PLACEHOLDER>

reconcile_all resolves conflicts in favor of the right-hand side when true and the left-hand side when false.

rhs: str = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.ConfigDiffRawResponse(diff_entries: 'ConfigDiff' = <PLACEHOLDER>, reconciled_config: str = <PLACEHOLDER>, error: 'CvpConfigError' = <PLACEHOLDER>)

Bases: Message

diff_entries: ConfigDiff = <PLACEHOLDER>

error: CvpConfigError = <PLACEHOLDER>

reconciled_config: str = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.ConfigDiffSummary(config_compliance: bool = <PLACEHOLDER>, nop: int = <PLACEHOLDER>, ignore: int = <PLACEHOLDER>, add: int = <PLACEHOLDER>, delete: int = <PLACEHOLDER>, change: int = <PLACEHOLDER>, digest: str = <PLACEHOLDER>, error: str = <PLACEHOLDER>)

Bases: Message

add: int = <PLACEHOLDER>

change: int = <PLACEHOLDER>

config_compliance: bool = <PLACEHOLDER>

delete: int = <PLACEHOLDER>

digest: str = <PLACEHOLDER>

error: str = <PLACEHOLDER>

ignore: int = <PLACEHOLDER>

nop: int = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.ConfigFilterCodes(in_line_filter_code: List[ForwardRef('InLineFilterCode')] = <PLACEHOLDER>)

Bases: Message

in_line_filter_code: InLineFilterCode] = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.ConfigRequest(type: 'ConfigType' = <PLACEHOLDER>, timestamp: datetime.datetime = <PLACEHOLDER>, device_id: str = <PLACEHOLDER>)

Bases: Message

device_id: str = <PLACEHOLDER>

timestamp: datetime = <PLACEHOLDER>

type: ConfigType = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.ConfigSource(source_type: 'ConfigSourceType' = <PLACEHOLDER>, key: str = <PLACEHOLDER>)

Bases: Message

key: str = <PLACEHOLDER>

source_type: ConfigSourceType = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.ConfigSourceType(value: int)

Bases: Enum

ConfigSourceType identifies where a source configuration was created.

CONFIG_TYPE_HIERARCHY = ConfigSourceType.CONFIG_TYPE_HIERARCHY

CONFIG_TYPE_HIERARCHY indicates a configuration generated by the Hierarchies workflow.

CONFIG_TYPE_STUDIO = ConfigSourceType.CONFIG_TYPE_STUDIO

CONFIG_TYPE_STUDIO indicates a configuration created through a Studio. ConfigSource.key is the Studio ID passed to the workspace API.

CONFIG_TYPE_STUDIO_STATIC = ConfigSourceType.CONFIG_TYPE_STUDIO_STATIC

CONFIG_TYPE_STUDIO_STATIC indicates a configlet created through a static configlet Studio. ConfigSource.key is the Studio configlet ID passed to the corresponding API.

CONFIG_TYPE_TOMCAT_CONFIGLET = ConfigSourceType.CONFIG_TYPE_TOMCAT_CONFIGLET

CONFIG_TYPE_TOMCAT_CONFIGLET indicates a configuration created by the Java backend. ConfigSource.key contains the configlet name for this type.

CONFIG_TYPE_UNSPECIFIED = ConfigSourceType.CONFIG_TYPE_UNSPECIFIED

CONFIG_TYPE_UNSPECIFIED indicates an unknown configuration source type.

name: str | None

value: int

class cloudvision.compliance.async.compliancecheck.ConfigSources(source: List[ForwardRef('ConfigSource')] = <PLACEHOLDER>)

Bases: Message

source: ConfigSource] = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.ConfigType(value: int)

Bases: Enum

ConfigType identifies a running or designed configuration.

CONFIGTYPE_UNSPECIFIED = ConfigType.CONFIGTYPE_UNSPECIFIED

CONFIGTYPE_UNSPECIFIED indicates an unknown configuration type.

DESIGNED_CONFIG = ConfigType.DESIGNED_CONFIG

DESIGNED_CONFIG indicates a designed configuration.

RUNNING_CONFIG = ConfigType.RUNNING_CONFIG

RUNNING_CONFIG indicates a running configuration.

name: str | None

value: int

class cloudvision.compliance.async.compliancecheck.CvpConfigError(error_code: ErrorCode = <PLACEHOLDER>, error_msg: str = <PLACEHOLDER>, line_num: int = <PLACEHOLDER>, configlet_name: str = <PLACEHOLDER>, config_line_num: int = <PLACEHOLDER>)

Bases: Message

CvpConfigError describes an error reported by CloudVision Portal or a device during configuration validation.

config_line_num: int = <PLACEHOLDER>

configlet_name: str = <PLACEHOLDER>

error_code: ErrorCode = <PLACEHOLDER>

error_msg: str = <PLACEHOLDER>

line_num: int = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.DiffEntry(op: DiffOp = <PLACEHOLDER>, a_lineno: int = <PLACEHOLDER>, b_lineno: int = <PLACEHOLDER>, a_parent_lineno: int = <PLACEHOLDER>, b_parent_lineno: int = <PLACEHOLDER>, a_line: str = <PLACEHOLDER>, b_line: str = <PLACEHOLDER>, a_filter_code: FilterCode = <PLACEHOLDER>, b_filter_code: FilterCode = <PLACEHOLDER>)

Bases: Message

DiffEntry represents one entry in a configuration diff.

a_filter_code: FilterCode = <PLACEHOLDER>

a_filter_code is the filter code for the line on side A.

a_line: str = <PLACEHOLDER>

a_line is the configuration line content on side A.

a_lineno: int = <PLACEHOLDER>

a_lineno is the line number on side A to which this diff applies.

a_parent_lineno: int = <PLACEHOLDER>

a_parent_lineno is the line number of the containing block’s leading command on side A.

b_filter_code: FilterCode = <PLACEHOLDER>

b_filter_code is the filter code for the line on side B.

b_line: str = <PLACEHOLDER>

b_line is the configuration line content on side B.

b_lineno: int = <PLACEHOLDER>

b_lineno is the line number on side B to which this diff applies.

b_parent_lineno: int = <PLACEHOLDER>

b_parent_lineno is the line number of the containing block’s leading command on side B.

op: DiffOp = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.DiffOp(value: int)

Bases: Enum

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

ADD = DiffOp.ADD

ADD indicates that a line was added to side A.

CHANGE = DiffOp.CHANGE

CHANGE indicates that a line on side A was modified.

DELETE = DiffOp.DELETE

DELETE indicates that a line was deleted from side B.

DIFFOP_UNSPECIFIED = DiffOp.DIFFOP_UNSPECIFIED

DIFFOP_UNSPECIFIED indicates an unknown diff operation.

IGNORE = DiffOp.IGNORE

IGNORE indicates a line ignored on either side A or B. One line number is -1.

NOP = DiffOp.NOP

NOP indicates that sides A and B are identical at this line.

name: str | None

value: int

class cloudvision.compliance.async.compliancecheck.ErrorCode(value: int)

Bases: Enum

ErrorCode indicates how an error should be handled.

DAOERROR = ErrorCode.DAOERROR

DAOERROR indicates a data access object error while manipulating the database.

DEVICEERROR = ErrorCode.DEVICEERROR

DEVICEERROR indicates a device error.

DEVICEWARNING = ErrorCode.DEVICEWARNING

DEVICEWARNING indicates a device warning.

ERRORCODE_UNSPECIFIED = ErrorCode.ERRORCODE_UNSPECIFIED

ERRORCODE_UNSPECIFIED indicates an unknown error code.

FILTERERROR = ErrorCode.FILTERERROR

FILTERERROR indicates an error from the proposed configuration management filters.

INACTIVEDEVICE = ErrorCode.INACTIVEDEVICE

INACTIVEDEVICE indicates that the device was not streaming.

OTHER = ErrorCode.OTHER

OTHER indicates an error that should be retained in the log.

PROPOSED_CONFIG_CHECK = ErrorCode.PROPOSED_CONFIG_CHECK

PROPOSED_CONFIG_CHECK indicates an issue with the content of proposed configuration.

UNREACHABLEDEVICE = ErrorCode.UNREACHABLEDEVICE

UNREACHABLEDEVICE indicates that the device cannot be reached.

name: str | None

value: int

class cloudvision.compliance.async.compliancecheck.Extension(name: str = <PLACEHOLDER>, version: str = <PLACEHOLDER>, reboot_required: bool = <PLACEHOLDER>, present: bool = <PLACEHOLDER>, installed: ExtensionInstallStatus = <PLACEHOLDER>, status_detail: str = <PLACEHOLDER>, is_embedded: bool = <PLACEHOLDER>, arch: str = <PLACEHOLDER>)

Bases: Message

Extension provides information about a running or designed extension.

arch: str = <PLACEHOLDER>

arch is the extension architecture.

installed: ExtensionInstallStatus = <PLACEHOLDER>

installed indicates whether the extension is installed, not installed, or force-installed.

is_embedded: bool = <PLACEHOLDER>

is_embedded indicates whether the extension is embedded in the EOS software image.

name: str = <PLACEHOLDER>

name is the name of the extension.

present: bool = <PLACEHOLDER>

present indicates whether the extension is present on the device.

reboot_required: bool = <PLACEHOLDER>

reboot_required indicates whether applying or deleting this extension would require a reboot.

status_detail: str = <PLACEHOLDER>

status_detail describes the extension status.

version: str = <PLACEHOLDER>

version is the version of the extension.

class cloudvision.compliance.async.compliancecheck.ExtensionDiff(code: ImageDiffOp = <PLACEHOLDER>, a: Extension = <PLACEHOLDER>, b: Extension = <PLACEHOLDER>, text_code: ImageDiffOp = <PLACEHOLDER>)

Bases: Message

ExtensionDiff is the diff between running and designed extensions.

a: Extension = <PLACEHOLDER>

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

b: Extension = <PLACEHOLDER>

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

code: ImageDiffOp = <PLACEHOLDER>

code is the operation performed to get from one side of the diff to the other.

text_code: ImageDiffOp = <PLACEHOLDER>

text_code is the color in the diff view page.

class cloudvision.compliance.async.compliancecheck.ExtensionDiffs(values: ExtensionDiff] = <PLACEHOLDER>)

Bases: Message

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

values: ExtensionDiff] = <PLACEHOLDER>

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

class cloudvision.compliance.async.compliancecheck.ExtensionDiffsBySup(values: Dict[str, ~cloudvision.compliance.async.compliancecheck.ExtensionDiffs]=<PLACEHOLDER>)

Bases: Message

ExtensionDiffsBySup is the extension diff information for each supervisor.

values: ExtensionDiffs] = <PLACEHOLDER>

values maps each supervisor type to its extension diffs.

class cloudvision.compliance.async.compliancecheck.ExtensionInfo(name: str = <PLACEHOLDER>, version: str = <PLACEHOLDER>, present_in_cvp: bool = <PLACEHOLDER>, present_in_device: bool = <PLACEHOLDER>, installed: bool = <PLACEHOLDER>, reboot_required: bool = <PLACEHOLDER>, install_details: str = <PLACEHOLDER>, status_detail: str = <PLACEHOLDER>, is_embedded: bool = <PLACEHOLDER>, arch: str = <PLACEHOLDER>)

Bases: Message

arch: str = <PLACEHOLDER>

install_details: str = <PLACEHOLDER>

installed: bool = <PLACEHOLDER>

is_embedded: bool = <PLACEHOLDER>

name: str = <PLACEHOLDER>

present_in_cvp: bool = <PLACEHOLDER>

present_in_device: bool = <PLACEHOLDER>

reboot_required: bool = <PLACEHOLDER>

status_detail: str = <PLACEHOLDER>

version: str = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.ExtensionInstallStatus(value: int)

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 that the extension is force-installed on the device.

INSTALLED = ExtensionInstallStatus.INSTALLED

EXTENSION_INSTALL_STATUS_INSTALLED indicates that the extension is installed on the device.

NOT_INSTALLED = ExtensionInstallStatus.NOT_INSTALLED

EXTENSION_INSTALL_STATUS_NOT_INSTALLED indicates that the extension is not installed on the device.

UNSPECIFIED = ExtensionInstallStatus.UNSPECIFIED

EXTENSION_INSTALL_STATUS_UNSPECIFIED indicates an unknown extension installation status.

name: str | None

value: int

class cloudvision.compliance.async.compliancecheck.FilterCode(value: int)

Bases: Enum

FilterCode identifies the proposed configuration management filter that a configuration line matches.

MANAGED_LINE = FilterCode.MANAGED_LINE

MANAGED_LINE indicates that the configuration line matches a managed filter.

UNMANAGED_LINE = FilterCode.UNMANAGED_LINE

UNMANAGED_LINE indicates that the configuration line matches an unmanaged filter.

UNSPECIFIED = FilterCode.UNSPECIFIED

UNSPECIFIED indicates that the configuration line did not match a filter.

name: str | None

value: int

class cloudvision.compliance.async.compliancecheck.GetConfigDiffForTaskRequest(task_id: str = <PLACEHOLDER>)

Bases: Message

task_id: str = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetConfigDiffForTaskResponse(diff: 'ConfigDiff' = <PLACEHOLDER>, error: 'CvpConfigError' = <PLACEHOLDER>, sources: 'ConfigSources' = <PLACEHOLDER>)

Bases: Message

diff: ConfigDiff = <PLACEHOLDER>

error: CvpConfigError = <PLACEHOLDER>

sources: ConfigSources = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetConfigDiffRequest(lhs: 'ConfigRequest' = <PLACEHOLDER>, rhs: 'ConfigRequest' = <PLACEHOLDER>)

Bases: Message

lhs: ConfigRequest = <PLACEHOLDER>

rhs: ConfigRequest = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetConfigDiffResponse(diff: 'ConfigDiff' = <PLACEHOLDER>, summary: 'ConfigDiffSummary' = <PLACEHOLDER>, lhs: 'CvpConfigError' = <PLACEHOLDER>, rhs: 'CvpConfigError' = <PLACEHOLDER>, sources: 'ConfigSources' = <PLACEHOLDER>)

Bases: Message

diff: ConfigDiff = <PLACEHOLDER>

lhs: CvpConfigError = <PLACEHOLDER>

rhs: CvpConfigError = <PLACEHOLDER>

sources: ConfigSources = <PLACEHOLDER>

sources contains the left-hand-side configuration sources.

summary: ConfigDiffSummary = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetConfigDiffSummaryForTaskRequest(task_id: str = <PLACEHOLDER>)

Bases: Message

task_id: str = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetConfigDiffSummaryForTaskResponse(summary: 'ConfigDiffSummary' = <PLACEHOLDER>)

Bases: Message

summary: ConfigDiffSummary = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetConfigDiffSummaryRequest(lhs: 'ConfigRequest' = <PLACEHOLDER>, rhs: 'ConfigRequest' = <PLACEHOLDER>)

Bases: Message

lhs: ConfigRequest = <PLACEHOLDER>

rhs: ConfigRequest = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetConfigDiffSummaryResponse(summary: 'ConfigDiffSummary' = <PLACEHOLDER>)

Bases: Message

summary: ConfigDiffSummary = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetConfigRequest(request: 'ConfigRequest' = <PLACEHOLDER>)

Bases: Message

request: ConfigRequest = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetConfigResponse(config: str = <PLACEHOLDER>, error: 'CvpConfigError' = <PLACEHOLDER>, config_filter_codes: 'ConfigFilterCodes' = <PLACEHOLDER>, sources: 'ConfigSources' = <PLACEHOLDER>)

Bases: Message

config: str = <PLACEHOLDER>

config_filter_codes: ConfigFilterCodes = <PLACEHOLDER>

error: CvpConfigError = <PLACEHOLDER>

sources: ConfigSources = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetDeviceStatusRequest(timestamp: datetime.datetime = <PLACEHOLDER>, device_id: str = <PLACEHOLDER>, task_type: 'TaskType' = <PLACEHOLDER>)

Bases: Message

device_id: str = <PLACEHOLDER>

task_type: TaskType = <PLACEHOLDER>

timestamp: datetime = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetDeviceStatusResponse(config_summary: 'ConfigDiffSummary' = <PLACEHOLDER>, image_status: 'ImageStatus' = <PLACEHOLDER>)

Bases: Message

config_summary: ConfigDiffSummary = <PLACEHOLDER>

image_status: ImageStatus = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetImageDiffForTaskRequest(task_id: str = <PLACEHOLDER>)

Bases: Message

task_id: str = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetImageDiffForTaskResponse(diff: 'ImageDiff' = <PLACEHOLDER>)

Bases: Message

diff: ImageDiff = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetImageDiffRequest(timestamp: datetime.datetime = <PLACEHOLDER>, device_id: str = <PLACEHOLDER>)

Bases: Message

device_id: str = <PLACEHOLDER>

timestamp: datetime = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetImageDiffRequestV2(lhs: 'ImageRequest' = <PLACEHOLDER>, rhs: 'ImageRequest' = <PLACEHOLDER>)

Bases: Message

lhs: ImageRequest = <PLACEHOLDER>

rhs: ImageRequest = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetImageDiffRequestV3(a: 'ImageRequest' = <PLACEHOLDER>, b: 'ImageRequest' = <PLACEHOLDER>)

Bases: Message

a: ImageRequest = <PLACEHOLDER>

b: ImageRequest = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetImageDiffResponse(diff: 'ImageDiff' = <PLACEHOLDER>)

Bases: Message

diff: ImageDiff = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetImageDiffResponseV2(lhs: 'ImageInfo' = <PLACEHOLDER>, rhs: 'ImageInfo' = <PLACEHOLDER>, image_reboot_required: bool = <PLACEHOLDER>, image_reboot_required_for_peer_sup: bool = <PLACEHOLDER>, extension_reboot_required: bool = <PLACEHOLDER>, extension_reboot_required_for_peer_sup: bool = <PLACEHOLDER>, digest: str = <PLACEHOLDER>)

Bases: Message

digest: str = <PLACEHOLDER>

extension_reboot_required: bool = <PLACEHOLDER>

extension_reboot_required_for_peer_sup: bool = <PLACEHOLDER>

image_reboot_required: bool = <PLACEHOLDER>

image_reboot_required_for_peer_sup: bool = <PLACEHOLDER>

lhs: ImageInfo = <PLACEHOLDER>

rhs: ImageInfo = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetImageDiffResponseV3(image_info: 'ImageInfoV3' = <PLACEHOLDER>, dual_sup_a: bool = <PLACEHOLDER>, dual_sup_b: bool = <PLACEHOLDER>, reboot_required: 'RebootRequired' = <PLACEHOLDER>, digest: str = <PLACEHOLDER>, source_a: 'ImageSource' = <PLACEHOLDER>, source_b: 'ImageSource' = <PLACEHOLDER>)

Bases: Message

digest: str = <PLACEHOLDER>

dual_sup_a: bool = <PLACEHOLDER>

dual_sup_b: bool = <PLACEHOLDER>

image_info: ImageInfoV3 = <PLACEHOLDER>

reboot_required: RebootRequired = <PLACEHOLDER>

source_a: ImageSource = <PLACEHOLDER>

source_b: ImageSource = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetProposedConfigRequest(configlet_ids: List[str] = <PLACEHOLDER>, device_id: str = <PLACEHOLDER>)

Bases: Message

configlet_ids: List[str] = <PLACEHOLDER>

device_id: str = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.GetProposedConfigResponse(config: str = <PLACEHOLDER>, error: 'CvpConfigError' = <PLACEHOLDER>, partial_config: str = <PLACEHOLDER>)

Bases: Message

config: str = <PLACEHOLDER>

error: CvpConfigError = <PLACEHOLDER>

partial_config: str = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.ImageDiff(running_image: str = <PLACEHOLDER>, running_image_for_peer_sup: str = <PLACEHOLDER>, running_extensions: List[ForwardRef('ExtensionInfo')] = <PLACEHOLDER>, running_extensions_for_peer_sup: List[ForwardRef('ExtensionInfo')] = <PLACEHOLDER>, designed_image: str = <PLACEHOLDER>, designed_extensions: List[ForwardRef('ExtensionInfo')] = <PLACEHOLDER>, image_reboot_required: bool = <PLACEHOLDER>, image_reboot_required_for_peer_sup: bool = <PLACEHOLDER>, extension_reboot_required: bool = <PLACEHOLDER>, extension_reboot_required_for_peer_sup: bool = <PLACEHOLDER>, dual_sup: bool = <PLACEHOLDER>, target_image_bundle: str = <PLACEHOLDER>, digest: str = <PLACEHOLDER>, running_image_version: str = <PLACEHOLDER>, running_image_version_for_peer_sup: str = <PLACEHOLDER>, designed_image_version: str = <PLACEHOLDER>, running_image_metadata: 'ImageMetadata' = <PLACEHOLDER>, running_image_metadata_for_peer_sup: 'ImageMetadata' = <PLACEHOLDER>, designed_image_metadata: 'ImageMetadata' = <PLACEHOLDER>, source: 'ImageSource' = <PLACEHOLDER>)

Bases: Message

designed_extensions: ExtensionInfo] = <PLACEHOLDER>

designed_image: str = <PLACEHOLDER>

designed_image_metadata: ImageMetadata = <PLACEHOLDER>

designed_image_version: str = <PLACEHOLDER>

digest: str = <PLACEHOLDER>

dual_sup: bool = <PLACEHOLDER>

extension_reboot_required: bool = <PLACEHOLDER>

extension_reboot_required_for_peer_sup: bool = <PLACEHOLDER>

image_reboot_required: bool = <PLACEHOLDER>

image_reboot_required_for_peer_sup: bool = <PLACEHOLDER>

running_extensions: ExtensionInfo] = <PLACEHOLDER>

running_extensions_for_peer_sup: ExtensionInfo] = <PLACEHOLDER>

running_image: str = <PLACEHOLDER>

running_image_for_peer_sup: str = <PLACEHOLDER>

running_image_metadata: ImageMetadata = <PLACEHOLDER>

running_image_metadata_for_peer_sup: ImageMetadata = <PLACEHOLDER>

running_image_version: str = <PLACEHOLDER>

running_image_version_for_peer_sup: str = <PLACEHOLDER>

source: ImageSource = <PLACEHOLDER>

target_image_bundle: str = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.ImageDiffOp(value: int)

Bases: Enum

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

DIFF_OP_ADD = ImageDiffOp.DIFF_OP_ADD

DIFF_OP_ADD indicates that software was added.

DIFF_OP_CHANGE = ImageDiffOp.DIFF_OP_CHANGE

DIFF_OP_CHANGE indicates that software was updated.

DIFF_OP_DELETE = ImageDiffOp.DIFF_OP_DELETE

DIFF_OP_DELETE indicates that software was deleted.

DIFF_OP_NOP = ImageDiffOp.DIFF_OP_NOP

DIFF_OP_NOP indicates no change.

DIFF_OP_UNSPECIFIED = ImageDiffOp.DIFF_OP_UNSPECIFIED

DIFF_OP_UNSPECIFIED indicates an unknown image diff operation.

name: str | None

value: int

class cloudvision.compliance.async.compliancecheck.ImageInfo(image: str = <PLACEHOLDER>, image_for_peer_sup: str = <PLACEHOLDER>, extensions: List[ForwardRef('ExtensionInfo')] = <PLACEHOLDER>, extensions_for_peer_sup: List[ForwardRef('ExtensionInfo')] = <PLACEHOLDER>, dual_sup: bool = <PLACEHOLDER>, target_image_bundle: str = <PLACEHOLDER>, image_version: str = <PLACEHOLDER>, image_version_for_peer_sup: str = <PLACEHOLDER>, image_metadata: 'ImageMetadata' = <PLACEHOLDER>, image_metadata_for_peer_sup: 'ImageMetadata' = <PLACEHOLDER>)

Bases: Message

dual_sup: bool = <PLACEHOLDER>

extensions: ExtensionInfo] = <PLACEHOLDER>

extensions_for_peer_sup: ExtensionInfo] = <PLACEHOLDER>

image: str = <PLACEHOLDER>

image_for_peer_sup: str = <PLACEHOLDER>

image_metadata: ImageMetadata = <PLACEHOLDER>

image_metadata_for_peer_sup: ImageMetadata = <PLACEHOLDER>

image_version: str = <PLACEHOLDER>

image_version_for_peer_sup: str = <PLACEHOLDER>

target_image_bundle: str = <PLACEHOLDER>

target_image_bundle is set only for a designed image.

class cloudvision.compliance.async.compliancecheck.ImageInfoV3(software_image_diff: 'SoftwareImageDiffsBySup' = <PLACEHOLDER>, terminattr_diff: 'TerminAttrDiffsBySup' = <PLACEHOLDER>, extensions_diff: 'ExtensionDiffsBySup' = <PLACEHOLDER>, compliance: 'ComplianceStatusBySup' = <PLACEHOLDER>, compliance_status: 'SoftwareComplianceCode' = <PLACEHOLDER>)

Bases: Message

compliance: ComplianceStatusBySup = <PLACEHOLDER>

compliance provides compliance information for each supervisor.

compliance_status: SoftwareComplianceCode = <PLACEHOLDER>

compliance_status is the aggregate status for active and standby supervisors, images, TerminAttr, and extensions.

extensions_diff: ExtensionDiffsBySup = <PLACEHOLDER>

extensions_diff contains the extension diffs for each supervisor.

software_image_diff: SoftwareImageDiffsBySup = <PLACEHOLDER>

software_image_diff contains the image diff for each supervisor.

terminattr_diff: TerminAttrDiffsBySup = <PLACEHOLDER>

terminattr_diff contains the TerminAttr diff for each supervisor.

class cloudvision.compliance.async.compliancecheck.ImageMetadata(version: str = <PLACEHOLDER>, release: str = <PLACEHOLDER>, flavor: str = <PLACEHOLDER>, variant: str = <PLACEHOLDER>, arch: str = <PLACEHOLDER>)

Bases: Message

ImageMetadata provides EOS image metadata.

arch: str = <PLACEHOLDER>

arch is the architecture of the EOS image.

flavor: str = <PLACEHOLDER>

flavor is the EOS image flavor. The default is “DEFAULT”; other values include DPE and 2GB.

release: str = <PLACEHOLDER>

release is the release name of the EOS image.

variant: str = <PLACEHOLDER>

variant is the EOS image variant, such as INT or US.

version: str = <PLACEHOLDER>

version is the version of the EOS image.

class cloudvision.compliance.async.compliancecheck.ImageRequest(type: 'ImageType' = <PLACEHOLDER>, timestamp: datetime.datetime = <PLACEHOLDER>, device_id: str = <PLACEHOLDER>)

Bases: Message

device_id: str = <PLACEHOLDER>

timestamp: datetime = <PLACEHOLDER>

type: ImageType = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.ImageSource(value: int)

Bases: Enum

ImageSource identifies the origin of an image change.

HIERARCHY = ImageSource.HIERARCHY

IMAGE_SOURCE_HIERARCHY indicates an image assigned through the hierarchies workflow.

NETWORK_PROVISIONING = ImageSource.NETWORK_PROVISIONING

IMAGE_SOURCE_NETWORK_PROVISIONING indicates an image assigned through network provisioning.

STUDIO = ImageSource.STUDIO

IMAGE_SOURCE_STUDIO indicates an image assigned through a Studio.

UNSPECIFIED = ImageSource.UNSPECIFIED

IMAGE_SOURCE_UNSPECIFIED indicates an unknown image source.

name: str | None

value: int

class cloudvision.compliance.async.compliancecheck.ImageStatus(dual_sup: bool = <PLACEHOLDER>, image_compliance: bool = <PLACEHOLDER>, extension_compliance: bool = <PLACEHOLDER>, extension_compliance_for_peer_sup: bool = <PLACEHOLDER>, error: str = <PLACEHOLDER>, image_compliance_for_peer_sup: bool = <PLACEHOLDER>)

Bases: Message

dual_sup: bool = <PLACEHOLDER>

error: str = <PLACEHOLDER>

extension_compliance: bool = <PLACEHOLDER>

extension_compliance_for_peer_sup: bool = <PLACEHOLDER>

image_compliance: bool = <PLACEHOLDER>

image_compliance_for_peer_sup: bool = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.ImageType(value: int)

Bases: Enum

ImageType identifies a running or designed image.

DESIGNED_IMAGE = ImageType.DESIGNED_IMAGE

DESIGNED_IMAGE indicates a designed image.

IMAGETYPE_UNSPECIFIED = ImageType.IMAGETYPE_UNSPECIFIED

IMAGETYPE_UNSPECIFIED indicates an unknown image type.

RUNNING_IMAGE = ImageType.RUNNING_IMAGE

RUNNING_IMAGE indicates a running image.

name: str | None

value: int

class cloudvision.compliance.async.compliancecheck.InLineFilterCode(line_no: int = <PLACEHOLDER>, filter_code: 'FilterCode' = <PLACEHOLDER>)

Bases: Message

filter_code: FilterCode = <PLACEHOLDER>

line_no: int = <PLACEHOLDER>

class cloudvision.compliance.async.compliancecheck.RebootRequired(software_image_reboot_required: bool = <PLACEHOLDER>, terminattr_reboot_required: bool = <PLACEHOLDER>, extension_reboot_required: bool = <PLACEHOLDER>)

Bases: Message

RebootRequired indicates switch-wide reboot requirements for software images, TerminAttr, and extensions.

extension_reboot_required: bool = <PLACEHOLDER>

extension_reboot_required indicates whether applying or deleting extensions requires a reboot.

software_image_reboot_required: bool = <PLACEHOLDER>

software_image_reboot_required indicates whether applying the software image requires a reboot.

terminattr_reboot_required: bool = <PLACEHOLDER>

terminattr_reboot_required indicates whether applying or deleting TerminAttr requires a reboot.

class cloudvision.compliance.async.compliancecheck.SoftwareComplianceCode(value: int)

Bases: Enum

SoftwareComplianceCode indicates possible compliance status.

IN_SYNC = SoftwareComplianceCode.IN_SYNC

SOFTWARE_COMPLIANCE_CODE_IN_SYNC indicates that designed and running images and extensions are identical.

OUT_OF_SYNC = SoftwareComplianceCode.OUT_OF_SYNC

SOFTWARE_COMPLIANCE_CODE_OUT_OF_SYNC indicates that designed and running images and extensions differ.

UNSPECIFIED = SoftwareComplianceCode.UNSPECIFIED

SOFTWARE_COMPLIANCE_CODE_UNSPECIFIED indicates compliance code is unspecified.

name: str | None

value: int

class cloudvision.compliance.async.compliancecheck.SoftwareImage(name: str = <PLACEHOLDER>, version: str = <PLACEHOLDER>, metadata: ImageMetadata = <PLACEHOLDER>)

Bases: Message

SoftwareImage describes a running or designed EOS image.

metadata: ImageMetadata = <PLACEHOLDER>

metadata is the metadata for the EOS image.

name: str = <PLACEHOLDER>

name is the name of the EOS image.

version: str = <PLACEHOLDER>

version is the version of the EOS image.

class cloudvision.compliance.async.compliancecheck.SoftwareImageDiff(code: ImageDiffOp = <PLACEHOLDER>, a: SoftwareImage = <PLACEHOLDER>, b: SoftwareImage = <PLACEHOLDER>, text_code: ImageDiffOp = <PLACEHOLDER>)

Bases: Message

SoftwareImageDiff is the diff between running and designed images.

a: SoftwareImage = <PLACEHOLDER>

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

b: SoftwareImage = <PLACEHOLDER>

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

code: ImageDiffOp = <PLACEHOLDER>

code is the operation performed to get from one side of the diff to the other.

text_code: ImageDiffOp = <PLACEHOLDER>

text_code is the color in the diff view page.

class cloudvision.compliance.async.compliancecheck.SoftwareImageDiffsBySup(values: Dict[str, ~cloudvision.compliance.async.compliancecheck.SoftwareImageDiff]=<PLACEHOLDER>)

Bases: Message

SoftwareImageDiffsBySup is software image diff information for each supervisor.

values: SoftwareImageDiff] = <PLACEHOLDER>

values maps each supervisor type to its image diff.

class cloudvision.compliance.async.compliancecheck.TaskType(value: int)

Bases: Enum

TaskType identifies the type of task.

CONFIG = TaskType.CONFIG

CONFIG indicates a configuration push task.

IMAGE = TaskType.IMAGE

IMAGE indicates an image push task.

TASKTYPE_UNSPECIFIED = TaskType.TASKTYPE_UNSPECIFIED

TASKTYPE_UNSPECIFIED indicates an unknown task type.

name: str | None

value: int

class cloudvision.compliance.async.compliancecheck.TerminAttrDiffsBySup(values: Dict[str, ~cloudvision.compliance.async.compliancecheck.ExtensionDiff]=<PLACEHOLDER>)

Bases: Message

TerminAttrDiffsBySup contains TerminAttr diff information for each supervisor.

values: ExtensionDiff] = <PLACEHOLDER>

values maps each supervisor type to its TerminAttr diff.