As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Osconfig v1alpha API

class google.cloud.osconfig_v1alpha.types.CVSSv3(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification- document

base_score

The base score is a function of the base metric scores. https://www.first.org/cvss/specification- document#Base-Metrics

Type

float

exploitability_score

The Exploitability sub-score equation is derived from the Base Exploitability metrics. https://www.first.org/cvss/specification- document#2-1-Exploitability-Metrics

Type

float

impact_score

The Impact sub-score equation is derived from the Base Impact metrics.

Type

float

attack_vector

This metric reflects the context by which vulnerability exploitation is possible.

Type

google.cloud.osconfig_v1alpha.types.CVSSv3.AttackVector

attack_complexity

This metric describes the conditions beyond the attacker’s control that must exist in order to exploit the vulnerability.

Type

google.cloud.osconfig_v1alpha.types.CVSSv3.AttackComplexity

privileges_required

This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.

Type

google.cloud.osconfig_v1alpha.types.CVSSv3.PrivilegesRequired

user_interaction

This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.

Type

google.cloud.osconfig_v1alpha.types.CVSSv3.UserInteraction

scope

The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.

Type

google.cloud.osconfig_v1alpha.types.CVSSv3.Scope

confidentiality_impact

This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability.

Type

google.cloud.osconfig_v1alpha.types.CVSSv3.Impact

integrity_impact

This metric measures the impact to integrity of a successfully exploited vulnerability.

Type

google.cloud.osconfig_v1alpha.types.CVSSv3.Impact

availability_impact

This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability.

Type

google.cloud.osconfig_v1alpha.types.CVSSv3.Impact

class AttackComplexity(value)[source]

Bases: proto.enums.Enum

This metric describes the conditions beyond the attacker’s control that must exist in order to exploit the vulnerability.

ATTACK_COMPLEXITY_HIGH = 2
ATTACK_COMPLEXITY_LOW = 1
ATTACK_COMPLEXITY_UNSPECIFIED = 0
class AttackVector(value)[source]

Bases: proto.enums.Enum

This metric reflects the context by which vulnerability exploitation is possible.

ATTACK_VECTOR_ADJACENT = 2
ATTACK_VECTOR_LOCAL = 3
ATTACK_VECTOR_NETWORK = 1
ATTACK_VECTOR_PHYSICAL = 4
ATTACK_VECTOR_UNSPECIFIED = 0
class Impact(value)[source]

Bases: proto.enums.Enum

The Impact metrics capture the effects of a successfully exploited vulnerability on the component that suffers the worst outcome that is most directly and predictably associated with the attack.

IMPACT_HIGH = 1
IMPACT_LOW = 2
IMPACT_NONE = 3
IMPACT_UNSPECIFIED = 0
class PrivilegesRequired(value)[source]

Bases: proto.enums.Enum

This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.

PRIVILEGES_REQUIRED_HIGH = 3
PRIVILEGES_REQUIRED_LOW = 2
PRIVILEGES_REQUIRED_NONE = 1
PRIVILEGES_REQUIRED_UNSPECIFIED = 0
class Scope(value)[source]

Bases: proto.enums.Enum

The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.

SCOPE_CHANGED = 2
SCOPE_UNCHANGED = 1
SCOPE_UNSPECIFIED = 0
class UserInteraction(value)[source]

Bases: proto.enums.Enum

This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.

USER_INTERACTION_NONE = 1
USER_INTERACTION_REQUIRED = 2
USER_INTERACTION_UNSPECIFIED = 0
class google.cloud.osconfig_v1alpha.types.CreateOSPolicyAssignmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request message to create an OS policy assignment

parent

Required. The parent resource name in the form: projects/{project}/locations/{location}

Type

str

os_policy_assignment

Required. The OS policy assignment to be created.

Type

google.cloud.osconfig_v1alpha.types.OSPolicyAssignment

os_policy_assignment_id

Required. The logical name of the OS policy assignment in the project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.

  • Must start with a letter.

  • Must be between 1-63 characters.

  • Must end with a number or a letter.

  • Must be unique within the project.

Type

str

class google.cloud.osconfig_v1alpha.types.DeleteOSPolicyAssignmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request message for deleting a OS policy assignment.

name

Required. The name of the OS policy assignment to be deleted

Type

str

class google.cloud.osconfig_v1alpha.types.FixedOrPercent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Message encapsulating a value that can be either absolute (“fixed”) or relative (“percent”) to a value.

fixed

Specifies a fixed value.

Type

int

percent

Specifies the relative value defined as a percentage, which will be multiplied by a reference value.

Type

int

class google.cloud.osconfig_v1alpha.types.GetInstanceOSPoliciesComplianceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request message for getting OS policies compliance data for the given Compute Engine VM instance.

name

Required. API resource name for instance OS policies compliance resource.

Format: projects/{project}/locations/{location}/instanceOSPoliciesCompliances/{instance}

For {project}, either Compute Engine project-number or project-id can be provided. For {instance}, either Compute Engine VM instance-id or instance-name can be provided.

Type

str

class google.cloud.osconfig_v1alpha.types.GetInventoryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request message for getting inventory data for the specified VM.

name

Required. API resource name for inventory resource.

Format: projects/{project}/locations/{location}/instances/{instance}/inventory

For {project}, either project-number or project-id can be provided. For {instance}, either Compute Engine instance-id or instance-name can be provided.

Type

str

view

Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.

Type

google.cloud.osconfig_v1alpha.types.InventoryView

class google.cloud.osconfig_v1alpha.types.GetOSPolicyAssignmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request message to get an OS policy assignment

name

Required. The resource name of OS policy assignment.

Format: projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}@{revisionId}

Type

str

class google.cloud.osconfig_v1alpha.types.GetVulnerabilityReportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request message for getting the vulnerability report for the specified VM.

name

Required. API resource name for vulnerability resource.

Format: projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport

For {project}, either project-number or project-id can be provided. For {instance}, either Compute Engine instance-id or instance-name can be provided.

Type

str

class google.cloud.osconfig_v1alpha.types.InstanceOSPoliciesCompliance(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

This API resource represents the OS policies compliance data for a Compute Engine virtual machine (VM) instance at a given point in time.

A Compute Engine VM can have multiple OS policy assignments, and each assignment can have multiple OS policies. As a result, multiple OS policies could be applied to a single VM.

You can use this API resource to determine both the compliance state of your VM as well as the compliance state of an individual OS policy.

For more information, see View compliance.

name

Output only. The InstanceOSPoliciesCompliance API resource name.

Format: projects/{project_number}/locations/{location}/instanceOSPoliciesCompliances/{instance_id}

Type

str

instance

Output only. The Compute Engine VM instance name.

Type

str

state

Output only. Compliance state of the VM.

Type

google.cloud.osconfig_v1alpha.types.OSPolicyComplianceState

detailed_state

Output only. Detailed compliance state of the VM. This field is populated only when compliance state is UNKNOWN.

It may contain one of the following values:

  • no-compliance-data: Compliance data is not available for this VM.

  • no-agent-detected: OS Config agent is not detected for this VM.

  • config-not-supported-by-agent: The version of the OS Config agent running on this VM does not support configuration management.

  • inactive: VM is not running.

  • internal-service-errors: There were internal service errors encountered while enforcing compliance.

  • agent-errors: OS config agent encountered errors while enforcing compliance.

Type

str

detailed_state_reason

Output only. The reason for the detailed_state of the VM (if any).

Type

str

os_policy_compliances

Output only. Compliance data for each OSPolicy that is applied to the VM.

Type

Sequence[google.cloud.osconfig_v1alpha.types.InstanceOSPoliciesCompliance.OSPolicyCompliance]

last_compliance_check_time

Output only. Timestamp of the last compliance check for the VM.

Type

google.protobuf.timestamp_pb2.Timestamp

last_compliance_run_id

Output only. Unique identifier for the last compliance run. This id will be logged by the OS config agent during a compliance run and can be used for debugging and tracing purpose.

Type

str

class OSPolicyCompliance(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Compliance data for an OS policy

os_policy_id

The OS policy id

Type

str

os_policy_assignment

Reference to the OSPolicyAssignment API resource that the OSPolicy belongs to.

Format: projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}

Type

str

state

Compliance state of the OS policy.

Type

google.cloud.osconfig_v1alpha.types.OSPolicyComplianceState

os_policy_resource_compliances

Compliance data for each OSPolicyResource that is applied to the VM.

Type

Sequence[google.cloud.osconfig_v1alpha.types.OSPolicyResourceCompliance]

class google.cloud.osconfig_v1alpha.types.Inventory(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

This API resource represents the available inventory data for a Compute Engine virtual machine (VM) instance at a given point in time.

You can use this API resource to determine the inventory data of your VM.

For more information, see Information provided by OS inventory management.

name

Output only. The Inventory API resource name.

Format: projects/{project_number}/locations/{location}/instances/{instance_id}/inventory

Type

str

os_info

Output only. Base level operating system information for the VM.

Type

google.cloud.osconfig_v1alpha.types.Inventory.OsInfo

items

Output only. Inventory items related to the VM keyed by an opaque unique identifier for each inventory item. The identifier is unique to each distinct and addressable inventory item and will change, when there is a new package version.

Type

Sequence[google.cloud.osconfig_v1alpha.types.Inventory.ItemsEntry]

update_time

Output only. Timestamp of the last reported inventory for the VM.

Type

google.protobuf.timestamp_pb2.Timestamp

class Item(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A single piece of inventory on a VM.

id

Identifier for this item, unique across items for this VM.

Type

str

origin_type

The origin of this inventory item.

Type

google.cloud.osconfig_v1alpha.types.Inventory.Item.OriginType

create_time

When this inventory item was first detected.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

When this inventory item was last modified.

Type

google.protobuf.timestamp_pb2.Timestamp

type_

The specific type of inventory, correlating to its specific details.

Type

google.cloud.osconfig_v1alpha.types.Inventory.Item.Type

installed_package

Software package present on the VM instance.

Type

google.cloud.osconfig_v1alpha.types.Inventory.SoftwarePackage

available_package

Software package available to be installed on the VM instance.

Type

google.cloud.osconfig_v1alpha.types.Inventory.SoftwarePackage

class OriginType(value)[source]

Bases: proto.enums.Enum

The origin of a specific inventory item.

INVENTORY_REPORT = 1
ORIGIN_TYPE_UNSPECIFIED = 0
class Type(value)[source]

Bases: proto.enums.Enum

The different types of inventory that are tracked on a VM.

AVAILABLE_PACKAGE = 2
INSTALLED_PACKAGE = 1
TYPE_UNSPECIFIED = 0
class ItemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class OsInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Operating system information for the VM.

hostname

The VM hostname.

Type

str

long_name

The operating system long name. For example ‘Debian GNU/Linux 9’ or ‘Microsoft Window Server 2019 Datacenter’.

Type

str

short_name

The operating system short name. For example, ‘windows’ or ‘debian’.

Type

str

version

The version of the operating system.

Type

str

architecture

The system architecture of the operating system.

Type

str

kernel_version

The kernel version of the operating system.

Type

str

kernel_release

The kernel release of the operating system.

Type

str

osconfig_agent_version

The current version of the OS Config agent running on the VM.

Type

str

class SoftwarePackage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Software package information of the operating system.

yum_package

Yum package info. For details about the yum package manager, see https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/6/html/deployment_guide/ch-yum.

Type

google.cloud.osconfig_v1alpha.types.Inventory.VersionedPackage

apt_package

Details of an APT package. For details about the apt package manager, see https://wiki.debian.org/Apt.

Type

google.cloud.osconfig_v1alpha.types.Inventory.VersionedPackage

zypper_package

Details of a Zypper package. For details about the Zypper package manager, see https://en.opensuse.org/SDB:Zypper_manual.

Type

google.cloud.osconfig_v1alpha.types.Inventory.VersionedPackage

googet_package

Details of a Googet package. For details about the googet package manager, see https://github.com/google/googet.

Type

google.cloud.osconfig_v1alpha.types.Inventory.VersionedPackage

zypper_patch

Details of a Zypper patch. For details about the Zypper package manager, see https://en.opensuse.org/SDB:Zypper_manual.

Type

google.cloud.osconfig_v1alpha.types.Inventory.ZypperPatch

wua_package

Details of a Windows Update package. See https://docs.microsoft.com/en-us/windows/win32/api/_wua/ for information about Windows Update.

Type

google.cloud.osconfig_v1alpha.types.Inventory.WindowsUpdatePackage

qfe_package

Details of a Windows Quick Fix engineering package. See https://docs.microsoft.com/en- us/windows/win32/cimwin32prov/win32-quickfixengineering for info in Windows Quick Fix Engineering.

Type

google.cloud.osconfig_v1alpha.types.Inventory.WindowsQuickFixEngineeringPackage

cos_package

Details of a COS package.

Type

google.cloud.osconfig_v1alpha.types.Inventory.VersionedPackage

windows_application

Details of Windows Application.

Type

google.cloud.osconfig_v1alpha.types.Inventory.WindowsApplication

class VersionedPackage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Information related to the a standard versioned package. This includes package info for APT, Yum, Zypper, and Googet package managers.

package_name

The name of the package.

Type

str

architecture

The system architecture this package is intended for.

Type

str

version

The version of the package.

Type

str

class WindowsApplication(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Contains information about a Windows application as retrieved from the Windows Registry. For more information about these fields, see

Windows Installer Properties for the Uninstall Registry{: class=”external” }

display_name

The name of the application or product.

Type

str

display_version

The version of the product or application in string format.

Type

str

publisher

The name of the manufacturer for the product or application.

Type

str

install_date

The last time this product received service. The value of this property is replaced each time a patch is applied or removed from the product or the command-line option is used to repair the product.

Type

google.type.date_pb2.Date

The internet address for technical support.

Type

str

class WindowsQuickFixEngineeringPackage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Information related to a Quick Fix Engineering package. Fields are taken from Windows QuickFixEngineering Interface and match the source names: https://docs.microsoft.com/en- us/windows/win32/cimwin32prov/win32-quickfixengineering

caption

A short textual description of the QFE update.

Type

str

description

A textual description of the QFE update.

Type

str

hot_fix_id

Unique identifier associated with a particular QFE update.

Type

str

install_time

Date that the QFE update was installed. Mapped from installed_on field.

Type

google.protobuf.timestamp_pb2.Timestamp

class WindowsUpdatePackage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Details related to a Windows Update package. Field data and names are taken from Windows Update API IUpdate Interface: https://docs.microsoft.com/en-us/windows/win32/api/_wua/ Descriptive fields like title, and description are localized based on the locale of the VM being updated.

title

The localized title of the update package.

Type

str

description

The localized description of the update package.

Type

str

categories

The categories that are associated with this update package.

Type

Sequence[google.cloud.osconfig_v1alpha.types.Inventory.WindowsUpdatePackage.WindowsUpdateCategory]

kb_article_ids

A collection of Microsoft Knowledge Base article IDs that are associated with the update package.

Type

Sequence[str]

support_url

A hyperlink to the language-specific support information for the update.

Type

str

more_info_urls

A collection of URLs that provide more information about the update package.

Type

Sequence[str]

update_id

Gets the identifier of an update package. Stays the same across revisions.

Type

str

revision_number

The revision number of this update package.

Type

int

last_deployment_change_time

The last published date of the update, in (UTC) date and time.

Type

google.protobuf.timestamp_pb2.Timestamp

class WindowsUpdateCategory(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Categories specified by the Windows Update.

id

The identifier of the windows update category.

Type

str

name

The name of the windows update category.

Type

str

class ZypperPatch(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Details related to a Zypper Patch.

patch_name

The name of the patch.

Type

str

category

The category of the patch.

Type

str

severity

The severity specified for this patch

Type

str

summary

Any summary information provided about this patch.

Type

str

class google.cloud.osconfig_v1alpha.types.InventoryView(value)[source]

Bases: proto.enums.Enum

The view for inventory objects.

BASIC = 1
FULL = 2
INVENTORY_VIEW_UNSPECIFIED = 0
class google.cloud.osconfig_v1alpha.types.ListInstanceOSPoliciesCompliancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request message for listing OS policies compliance data for all Compute Engine VMs in the given location.

parent

Required. The parent resource name.

Format: projects/{project}/locations/{location}

For {project}, either Compute Engine project-number or project-id can be provided.

Type

str

page_size

The maximum number of results to return.

Type

int

page_token

A pagination token returned from a previous call to ListInstanceOSPoliciesCompliances that indicates where this listing should continue from.

Type

str

filter

If provided, this field specifies the criteria that must be met by a InstanceOSPoliciesCompliance API resource to be included in the response.

Type

str

class google.cloud.osconfig_v1alpha.types.ListInstanceOSPoliciesCompliancesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A response message for listing OS policies compliance data for all Compute Engine VMs in the given location.

instance_os_policies_compliances

List of instance OS policies compliance objects.

Type

Sequence[google.cloud.osconfig_v1alpha.types.InstanceOSPoliciesCompliance]

next_page_token

The pagination token to retrieve the next page of instance OS policies compliance objects.

Type

str

property raw_page
class google.cloud.osconfig_v1alpha.types.ListInventoriesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request message for listing inventory data for all VMs in the specified location.

parent

Required. The parent resource name.

Format: projects/{project}/locations/{location}/instances/{instance}

For {project}, either project-number or project-id can be provided. For {instance}, only hyphen or dash character is supported to list inventories across VMs.

Type

str

view

Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.

Type

google.cloud.osconfig_v1alpha.types.InventoryView

page_size

The maximum number of results to return.

Type

int

page_token

A pagination token returned from a previous call to ListInventories that indicates where this listing should continue from.

Type

str

filter

If provided, this field specifies the criteria that must be met by a Inventory API resource to be included in the response.

Type

str

class google.cloud.osconfig_v1alpha.types.ListInventoriesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A response message for listing inventory data for all VMs in a specified location.

inventories

List of inventory objects.

Type

Sequence[google.cloud.osconfig_v1alpha.types.Inventory]

next_page_token

The pagination token to retrieve the next page of inventory objects.

Type

str

property raw_page
class google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentRevisionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request message to list revisions for a OS policy assignment

name

Required. The name of the OS policy assignment to list revisions for.

Type

str

page_size

The maximum number of revisions to return.

Type

int

page_token

A pagination token returned from a previous call to ListOSPolicyAssignmentRevisions that indicates where this listing should continue from.

Type

str

class google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentRevisionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A response message for listing all revisions for a OS policy assignment.

os_policy_assignments

The OS policy assignment revisions

Type

Sequence[google.cloud.osconfig_v1alpha.types.OSPolicyAssignment]

next_page_token

The pagination token to retrieve the next page of OS policy assignment revisions.

Type

str

property raw_page
class google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request message to list OS policy assignments for a parent resource

parent

Required. The parent resource name.

Type

str

page_size

The maximum number of assignments to return.

Type

int

page_token

A pagination token returned from a previous call to ListOSPolicyAssignments that indicates where this listing should continue from.

Type

str

class google.cloud.osconfig_v1alpha.types.ListOSPolicyAssignmentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A response message for listing all assignments under given parent.

os_policy_assignments

The list of assignments

Type

Sequence[google.cloud.osconfig_v1alpha.types.OSPolicyAssignment]

next_page_token

The pagination token to retrieve the next page of OS policy assignments.

Type

str

property raw_page
class google.cloud.osconfig_v1alpha.types.ListVulnerabilityReportsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request message for listing vulnerability reports for all VM instances in the specified location.

parent

Required. The parent resource name.

Format: projects/{project}/locations/{location}/instances/{instance}

For {project}, either project-number or project-id can be provided. For {instance}, only - character is supported to list vulnerability reports across VMs.

Type

str

page_size

The maximum number of results to return.

Type

int

page_token

A pagination token returned from a previous call to ListVulnerabilityReports that indicates where this listing should continue from.

Type

str

filter

If provided, this field specifies the criteria that must be met by a vulnerabilityReport API resource to be included in the response.

Type

str

class google.cloud.osconfig_v1alpha.types.ListVulnerabilityReportsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A response message for listing vulnerability reports for all VM instances in the specified location.

vulnerability_reports

List of vulnerabilityReport objects.

Type

Sequence[google.cloud.osconfig_v1alpha.types.VulnerabilityReport]

next_page_token

The pagination token to retrieve the next page of vulnerabilityReports object.

Type

str

property raw_page
class google.cloud.osconfig_v1alpha.types.OSPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

An OS policy defines the desired state configuration for a VM.

id

Required. The id of the OS policy with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.

  • Must start with a letter.

  • Must be between 1-63 characters.

  • Must end with a number or a letter.

  • Must be unique within the assignment.

Type

str

description

Policy description. Length of the description is limited to 1024 characters.

Type

str

mode

Required. Policy mode

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Mode

resource_groups

Required. List of resource groups for the policy. For a particular VM, resource groups are evaluated in the order specified and the first resource group that is applicable is selected and the rest are ignored.

If none of the resource groups are applicable for a VM, the VM is considered to be non-compliant w.r.t this policy. This behavior can be toggled by the flag allow_no_resource_group_match

Type

Sequence[google.cloud.osconfig_v1alpha.types.OSPolicy.ResourceGroup]

allow_no_resource_group_match

This flag determines the OS policy compliance status when none of the resource groups within the policy are applicable for a VM. Set this value to true if the policy needs to be reported as compliant even if the policy has nothing to validate or enforce.

Type

bool

class Mode(value)[source]

Bases: proto.enums.Enum

Policy mode

ENFORCEMENT = 2
MODE_UNSPECIFIED = 0
VALIDATION = 1
class OSFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The OSFilter is used to specify the OS filtering criteria for the resource group.

os_short_name

This should match OS short name emitted by the OS inventory agent. An empty value matches any OS.

Type

str

os_version

This value should match the version emitted by the OS inventory agent. Prefix matches are supported if asterisk(*) is provided as the last character. For example, to match all versions with a major version of 7, specify the following value for this field 7.*

Type

str

class Resource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

An OS policy resource is used to define the desired state configuration and provides a specific functionality like installing/removing packages, executing a script etc.

The system ensures that resources are always in their desired state by taking necessary actions if they have drifted from their desired state.

id

Required. The id of the resource with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.

  • Must start with a letter.

  • Must be between 1-63 characters.

  • Must end with a number or a letter.

  • Must be unique within the OS policy.

Type

str

pkg

Package resource

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.PackageResource

repository

Package repository resource

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.RepositoryResource

exec_

Exec resource

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.ExecResource

file

File resource

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.FileResource

class ExecResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A resource that allows executing scripts on the VM.

The ExecResource has 2 stages: validate and enforce and both stages accept a script as an argument to execute.

When the ExecResource is applied by the agent, it first executes the script in the validate stage. The validate stage can signal that the ExecResource is already in the desired state by returning an exit code of 100. If the ExecResource is not in the desired state, it should return an exit code of 101. Any other exit code returned by this stage is considered an error.

If the ExecResource is not in the desired state based on the exit code from the validate stage, the agent proceeds to execute the script from the enforce stage. If the ExecResource is already in the desired state, the enforce stage will not be run. Similar to validate stage, the enforce stage should return an exit code of 100 to indicate that the resource in now in its desired state. Any other exit code is considered an error.

NOTE: An exit code of 100 was chosen over 0 (and 101 vs 1) to have an explicit indicator of in desired state, not in desired state and errors. Because, for example, Powershell will always return an exit code of 0 unless an exit statement is provided in the script. So, for reasons of consistency and being explicit, exit codes 100 and 101 were chosen.

validate

Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates “in desired state”, and exit code of 101 indicates “not in desired state”. Any other exit code indicates a failure running validate.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.ExecResource.Exec

enforce

What to run to bring this resource into the desired state. An exit code of 100 indicates “success”, any other exit code indicates a failure running enforce.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.ExecResource.Exec

class Exec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A file or script to execute.

file

A remote or local file.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.File

script

An inline script. The size of the script is limited to 1024 characters.

Type

str

args

Optional arguments to pass to the source during execution.

Type

Sequence[str]

interpreter

Required. The script interpreter to use.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.ExecResource.Exec.Interpreter

output_file_path

Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes.

Type

str

class Interpreter(value)[source]

Bases: proto.enums.Enum

The interpreter to use.

INTERPRETER_UNSPECIFIED = 0
NONE = 1
POWERSHELL = 3
SHELL = 2
class File(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A remote or local file.

remote

A generic remote file.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.File.Remote

gcs

A Cloud Storage object.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.File.Gcs

local_path

A local path within the VM to use.

Type

str

allow_insecure

Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified.

Type

bool

class Gcs(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Specifies a file available as a Cloud Storage Object.

bucket

Required. Bucket of the Cloud Storage object.

Type

str

object_

Required. Name of the Cloud Storage object.

Type

str

generation

Generation number of the Cloud Storage object.

Type

int

class Remote(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Specifies a file available via some URI.

uri

Required. URI from which to fetch the object. It should contain both the protocol and path following the format {protocol}://{location}.

Type

str

sha256_checksum

SHA256 checksum of the remote file.

Type

str

class FileResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A resource that manages the state of a file.

file

A remote or local source.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.File

content

A a file with this content. The size of the content is limited to 1024 characters.

Type

str

path

Required. The absolute path of the file within the VM.

Type

str

state

Required. Desired state of the file.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.FileResource.DesiredState

permissions

Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755.

Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4

Type

str

class DesiredState(value)[source]

Bases: proto.enums.Enum

Desired state of the file.

ABSENT = 2
CONTENTS_MATCH = 3
DESIRED_STATE_UNSPECIFIED = 0
PRESENT = 1
class PackageResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A resource that manages a system package.

desired_state

Required. The desired state the agent should maintain for this package.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.PackageResource.DesiredState

apt

A package managed by Apt.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.PackageResource.APT

deb

A deb package file.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.PackageResource.Deb

yum

A package managed by YUM.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.PackageResource.YUM

zypper

A package managed by Zypper.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.PackageResource.Zypper

rpm

An rpm package file.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.PackageResource.RPM

googet

A package managed by GooGet.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.PackageResource.GooGet

msi

An MSI package.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.PackageResource.MSI

class APT(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A package managed by APT.

  • install: apt-get update && apt-get -y install [name]

  • remove: apt-get -y remove [name]

name

Required. Package name.

Type

str

class Deb(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A deb package file. dpkg packages only support INSTALLED state.

source

Required. A deb package.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.File

pull_deps

Whether dependencies should also be installed.

  • install when false: dpkg -i package

  • install when true: apt-get update && apt-get -y install package.deb

Type

bool

class DesiredState(value)[source]

Bases: proto.enums.Enum

The desired state that the OS Config agent maintains on the VM.

DESIRED_STATE_UNSPECIFIED = 0
INSTALLED = 1
REMOVED = 2
class GooGet(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A package managed by GooGet.

  • install: googet -noconfirm install package

  • remove: googet -noconfirm remove package

name

Required. Package name.

Type

str

class MSI(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

An MSI package. MSI packages only support INSTALLED state.

source

Required. The MSI package.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.File

properties

Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of ACTION=INSTALL REBOOT=ReallySuppress.

Type

Sequence[str]

class RPM(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

An RPM package file. RPM packages only support INSTALLED state.

source

Required. An rpm package.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.File

pull_deps

Whether dependencies should also be installed.

  • install when false: rpm --upgrade --replacepkgs package.rpm

  • install when true: yum -y install package.rpm or zypper -y install package.rpm

Type

bool

class YUM(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A package managed by YUM.

  • install: yum -y install package

  • remove: yum -y remove package

name

Required. Package name.

Type

str

class Zypper(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A package managed by Zypper.

  • install: zypper -y install package

  • remove: zypper -y rm package

name

Required. Package name.

Type

str

class RepositoryResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A resource that manages a package repository.

apt

An Apt Repository.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.RepositoryResource.AptRepository

yum

A Yum Repository.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.RepositoryResource.YumRepository

zypper

A Zypper Repository.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.RepositoryResource.ZypperRepository

goo

A Goo Repository.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.RepositoryResource.GooRepository

class AptRepository(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents a single apt package repository. These will be added to a repo file that will be managed at /etc/apt/sources.list.d/google_osconfig.list.

archive_type

Required. Type of archive files in this repository.

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.Resource.RepositoryResource.AptRepository.ArchiveType

uri

Required. URI for this repository.

Type

str

distribution

Required. Distribution of this repository.

Type

str

components

Required. List of components for this repository. Must contain at least one item.

Type

Sequence[str]

gpg_key

URI of the key file for this repository. The agent maintains a keyring at /etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg.

Type

str

class ArchiveType(value)[source]

Bases: proto.enums.Enum

Type of archive.

ARCHIVE_TYPE_UNSPECIFIED = 0
DEB = 1
DEB_SRC = 2
class GooRepository(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents a Goo package repository. These are added to a repo file that is managed at C:/ProgramData/GooGet/repos/google_osconfig.repo.

name

Required. The name of the repository.

Type

str

url

Required. The url of the repository.

Type

str

class YumRepository(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents a single yum package repository. These are added to a repo file that is managed at /etc/yum.repos.d/google_osconfig.repo.

id

Required. A one word, unique name for this repository. This is the repo id in the yum config file and also the display_name if display_name is omitted. This id is also used as the unique identifier when checking for resource conflicts.

Type

str

display_name

The display name of the repository.

Type

str

base_url

Required. The location of the repository directory.

Type

str

gpg_keys

URIs of GPG keys.

Type

Sequence[str]

class ZypperRepository(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents a single zypper package repository. These are added to a repo file that is managed at /etc/zypp/repos.d/google_osconfig.repo.

id

Required. A one word, unique name for this repository. This is the repo id in the zypper config file and also the display_name if display_name is omitted. This id is also used as the unique identifier when checking for GuestPolicy conflicts.

Type

str

display_name

The display name of the repository.

Type

str

base_url

Required. The location of the repository directory.

Type

str

gpg_keys

URIs of GPG keys.

Type

Sequence[str]

class ResourceGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Resource groups provide a mechanism to group OS policy resources.

Resource groups enable OS policy authors to create a single OS policy to be applied to VMs running different operating Systems.

When the OS policy is applied to a target VM, the appropriate resource group within the OS policy is selected based on the OSFilter specified within the resource group.

os_filter

Used to specify the OS filter for a resource group

Type

google.cloud.osconfig_v1alpha.types.OSPolicy.OSFilter

resources

Required. List of resources configured for this resource group. The resources are executed in the exact order specified here.

Type

Sequence[google.cloud.osconfig_v1alpha.types.OSPolicy.Resource]

class google.cloud.osconfig_v1alpha.types.OSPolicyAssignment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances.

An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script.

For more information, see OS policy and OS policy assignment.

name

Resource name.

Format: projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}

This field is ignored when you create an OS policy assignment.

Type

str

description

OS policy assignment description. Length of the description is limited to 1024 characters.

Type

str

os_policies

Required. List of OS policies to be applied to the VMs.

Type

Sequence[google.cloud.osconfig_v1alpha.types.OSPolicy]

instance_filter

Required. Filter to select VMs.

Type

google.cloud.osconfig_v1alpha.types.OSPolicyAssignment.InstanceFilter

rollout

Required. Rollout to deploy the OS policy assignment. A rollout is triggered in the following situations:

  1. OSPolicyAssignment is created.

  2. OSPolicyAssignment is updated and the update contains changes to one of the following fields:

    • instance_filter

    • os_policies

  3. OSPolicyAssignment is deleted.

Type

google.cloud.osconfig_v1alpha.types.OSPolicyAssignment.Rollout

revision_id

Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment

Type

str

revision_create_time

Output only. The timestamp that the revision was created.

Type

google.protobuf.timestamp_pb2.Timestamp

rollout_state

Output only. OS policy assignment rollout state

Type

google.cloud.osconfig_v1alpha.types.OSPolicyAssignment.RolloutState

baseline

Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision.

For a given OS policy assignment, there is only one revision with a value of true for this field.

Type

bool

deleted

Output only. Indicates that this revision deletes the OS policy assignment.

Type

bool

reconciling

Output only. Indicates that reconciliation is in progress for the revision. This value is true when the rollout_state is one of:

  • IN_PROGRESS

  • CANCELLING

Type

bool

uid

Output only. Server generated unique id for the OS policy assignment resource.

Type

str

class InstanceFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Message to represent the filters to select VMs for an assignment

all_

Target all VMs in the project. If true, no other criteria is permitted.

Type

bool

os_short_names

A VM is included if it’s OS short name matches with any of the values provided in this list.

Type

Sequence[str]

inclusion_labels

List of label sets used for VM inclusion.

If the list has more than one LabelSet, the VM is included if any of the label sets are applicable for the VM.

Type

Sequence[google.cloud.osconfig_v1alpha.types.OSPolicyAssignment.LabelSet]

exclusion_labels

List of label sets used for VM exclusion. If the list has more than one label set, the VM is excluded if any of the label sets are applicable for the VM.

This filter is applied last in the filtering chain and therefore a VM is guaranteed to be excluded if it satisfies one of the below label sets.

Type

Sequence[google.cloud.osconfig_v1alpha.types.OSPolicyAssignment.LabelSet]

class LabelSet(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Message representing label set.

  • A label is a key value pair set for a VM.

  • A LabelSet is a set of labels.

  • Labels within a LabelSet are ANDed. In other words, a LabelSet is applicable for a VM only if it matches all the labels in the LabelSet.

  • Example: A LabelSet with 2 labels: env=prod and type=webserver will only be applicable for those VMs with both labels present.

labels

Labels are identified by key/value pairs in this map. A VM should contain all the key/value pairs specified in this map to be selected.

Type

Sequence[google.cloud.osconfig_v1alpha.types.OSPolicyAssignment.LabelSet.LabelsEntry]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class Rollout(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Message to configure the rollout at the zonal level for the OS policy assignment.

disruption_budget

Required. The maximum number (or percentage) of VMs per zone to disrupt at any given moment.

Type

google.cloud.osconfig_v1alpha.types.FixedOrPercent

min_wait_duration

Required. This determines the minimum duration of time to wait after the configuration changes are applied through the current rollout. A VM continues to count towards the disruption_budget at least until this duration of time has passed after configuration changes are applied.

Type

google.protobuf.duration_pb2.Duration

class RolloutState(value)[source]

Bases: proto.enums.Enum

OS policy assignment rollout state

CANCELLED = 3
CANCELLING = 2
IN_PROGRESS = 1
ROLLOUT_STATE_UNSPECIFIED = 0
SUCCEEDED = 4
class google.cloud.osconfig_v1alpha.types.OSPolicyAssignmentOperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.

os_policy_assignment

Reference to the OSPolicyAssignment API resource.

Format: projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}

Type

str

api_method

The OS policy assignment API method.

Type

google.cloud.osconfig_v1alpha.types.OSPolicyAssignmentOperationMetadata.APIMethod

rollout_state

State of the rollout

Type

google.cloud.osconfig_v1alpha.types.OSPolicyAssignmentOperationMetadata.RolloutState

rollout_start_time

Rollout start time

Type

google.protobuf.timestamp_pb2.Timestamp

rollout_update_time

Rollout update time

Type

google.protobuf.timestamp_pb2.Timestamp

class APIMethod(value)[source]

Bases: proto.enums.Enum

The OS policy assignment API method.

API_METHOD_UNSPECIFIED = 0
CREATE = 1
DELETE = 3
UPDATE = 2
class RolloutState(value)[source]

Bases: proto.enums.Enum

State of the rollout

CANCELLED = 3
CANCELLING = 2
IN_PROGRESS = 1
ROLLOUT_STATE_UNSPECIFIED = 0
SUCCEEDED = 4
class google.cloud.osconfig_v1alpha.types.OSPolicyComplianceState(value)[source]

Bases: proto.enums.Enum

Supported OSPolicy compliance states.

COMPLIANT = 1
NON_COMPLIANT = 2
NO_OS_POLICIES_APPLICABLE = 4
OS_POLICY_COMPLIANCE_STATE_UNSPECIFIED = 0
UNKNOWN = 3
class google.cloud.osconfig_v1alpha.types.OSPolicyResourceCompliance(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Compliance data for an OS policy resource.

os_policy_resource_id

The id of the OS policy resource.

Type

str

config_steps

Ordered list of configuration steps taken by the agent for the OS policy resource.

Type

Sequence[google.cloud.osconfig_v1alpha.types.OSPolicyResourceConfigStep]

state

Compliance state of the OS policy resource.

Type

google.cloud.osconfig_v1alpha.types.OSPolicyComplianceState

exec_resource_output

ExecResource specific output.

Type

google.cloud.osconfig_v1alpha.types.OSPolicyResourceCompliance.ExecResourceOutput

class ExecResourceOutput(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

ExecResource specific output.

enforcement_output

Output from Enforcement phase output file (if run). Output size is limited to 100K bytes.

Type

bytes

class google.cloud.osconfig_v1alpha.types.OSPolicyResourceConfigStep(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Step performed by the OS Config agent for configuring an OSPolicyResource to its desired state.

type_

Configuration step type.

Type

google.cloud.osconfig_v1alpha.types.OSPolicyResourceConfigStep.Type

outcome

Outcome of the configuration step.

Type

google.cloud.osconfig_v1alpha.types.OSPolicyResourceConfigStep.Outcome

error_message

An error message recorded during the execution of this step. Only populated when outcome is FAILED.

Type

str

class Outcome(value)[source]

Bases: proto.enums.Enum

Supported outcomes for a configuration step.

FAILED = 2
OUTCOME_UNSPECIFIED = 0
SUCCEEDED = 1
class Type(value)[source]

Bases: proto.enums.Enum

Supported configuration step types

DESIRED_STATE_CHECK = 2
DESIRED_STATE_CHECK_POST_ENFORCEMENT = 4
DESIRED_STATE_ENFORCEMENT = 3
TYPE_UNSPECIFIED = 0
VALIDATION = 1
class google.cloud.osconfig_v1alpha.types.UpdateOSPolicyAssignmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request message to update an OS policy assignment

os_policy_assignment

Required. The updated OS policy assignment.

Type

google.cloud.osconfig_v1alpha.types.OSPolicyAssignment

update_mask

Optional. Field mask that controls which fields of the assignment should be updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.osconfig_v1alpha.types.VulnerabilityReport(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

This API resource represents the vulnerability report for a specified Compute Engine virtual machine (VM) instance at a given point in time.

For more information, see Vulnerability reports.

name

Output only. The vulnerabilityReport API resource name.

Format: projects/{project_number}/locations/{location}/instances/{instance_id}/vulnerabilityReport

Type

str

vulnerabilities

Output only. List of vulnerabilities affecting the VM.

Type

Sequence[google.cloud.osconfig_v1alpha.types.VulnerabilityReport.Vulnerability]

update_time

Output only. The timestamp for when the last vulnerability report was generated for the VM.

Type

google.protobuf.timestamp_pb2.Timestamp

class Vulnerability(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A vulnerability affecting the VM instance.

details

Contains metadata as per the upstream feed of the operating system and NVD.

Type

google.cloud.osconfig_v1alpha.types.VulnerabilityReport.Vulnerability.Details

installed_inventory_item_ids

Corresponds to the INSTALLED_PACKAGE inventory item on the VM. This field displays the inventory items affected by this vulnerability. If the vulnerability report was not updated after the VM inventory update, these values might not display in VM inventory. For some distros, this field may be empty.

Type

Sequence[str]

available_inventory_item_ids

Corresponds to the AVAILABLE_PACKAGE inventory item on the VM. If the vulnerability report was not updated after the VM inventory update, these values might not display in VM inventory. If there is no available fix, the field is empty. The inventory_item value specifies the latest SoftwarePackage available to the VM that fixes the vulnerability.

Type

Sequence[str]

create_time

The timestamp for when the vulnerability was first detected.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

The timestamp for when the vulnerability was last modified.

Type

google.protobuf.timestamp_pb2.Timestamp

class Details(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Contains metadata information for the vulnerability. This information is collected from the upstream feed of the operating system.

cve

The CVE of the vulnerability. CVE cannot be empty and the combination of <cve, classification> should be unique across vulnerabilities for a VM.

Type

str

cvss_v2_score

The CVSS V2 score of this vulnerability. CVSS V2 score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.

Type

float

cvss_v3

The full description of the CVSSv3 for this vulnerability from NVD.

Type

google.cloud.osconfig_v1alpha.types.CVSSv3

severity

Assigned severity/impact ranking from the distro.

Type

str

description

The note or description describing the vulnerability from the distro.

Type

str

references

Corresponds to the references attached to the VulnerabilityDetails.

Type

Sequence[google.cloud.osconfig_v1alpha.types.VulnerabilityReport.Vulnerability.Details.Reference]

class Reference(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A reference for this vulnerability.

url

The url of the reference.

Type

str