Package Classes (1.18.0)

OS Config API

The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances.

OS Config API

The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances.

A pager for iterating through list_patch_deployments requests.

This class thinly wraps an initial ListPatchDeploymentsResponse object, and provides an __aiter__ method to iterate through its patch_deployments field.

If there are more pages, the __aiter__ method will make additional ListPatchDeployments requests and continue to iterate through the patch_deployments field on the corresponding responses.

All the usual ListPatchDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_patch_deployments requests.

This class thinly wraps an initial ListPatchDeploymentsResponse object, and provides an __iter__ method to iterate through its patch_deployments field.

If there are more pages, the __iter__ method will make additional ListPatchDeployments requests and continue to iterate through the patch_deployments field on the corresponding responses.

All the usual ListPatchDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_patch_job_instance_details requests.

This class thinly wraps an initial ListPatchJobInstanceDetailsResponse object, and provides an __aiter__ method to iterate through its patch_job_instance_details field.

If there are more pages, the __aiter__ method will make additional ListPatchJobInstanceDetails requests and continue to iterate through the patch_job_instance_details field on the corresponding responses.

All the usual ListPatchJobInstanceDetailsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_patch_job_instance_details requests.

This class thinly wraps an initial ListPatchJobInstanceDetailsResponse object, and provides an __iter__ method to iterate through its patch_job_instance_details field.

If there are more pages, the __iter__ method will make additional ListPatchJobInstanceDetails requests and continue to iterate through the patch_job_instance_details field on the corresponding responses.

All the usual ListPatchJobInstanceDetailsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_patch_jobs requests.

This class thinly wraps an initial ListPatchJobsResponse object, and provides an __aiter__ method to iterate through its patch_jobs field.

If there are more pages, the __aiter__ method will make additional ListPatchJobs requests and continue to iterate through the patch_jobs field on the corresponding responses.

All the usual ListPatchJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_patch_jobs requests.

This class thinly wraps an initial ListPatchJobsResponse object, and provides an __iter__ method to iterate through its patch_jobs field.

If there are more pages, the __iter__ method will make additional ListPatchJobs requests and continue to iterate through the patch_jobs field on the corresponding responses.

All the usual ListPatchJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Zonal OS Config API

The OS Config service is the server-side component that allows users to manage package installations and patch jobs for Compute Engine VM instances.

Zonal OS Config API

The OS Config service is the server-side component that allows users to manage package installations and patch jobs for Compute Engine VM instances.

A pager for iterating through list_inventories requests.

This class thinly wraps an initial ListInventoriesResponse object, and provides an __aiter__ method to iterate through its inventories field.

If there are more pages, the __aiter__ method will make additional ListInventories requests and continue to iterate through the inventories field on the corresponding responses.

All the usual ListInventoriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_inventories requests.

This class thinly wraps an initial ListInventoriesResponse object, and provides an __iter__ method to iterate through its inventories field.

If there are more pages, the __iter__ method will make additional ListInventories requests and continue to iterate through the inventories field on the corresponding responses.

All the usual ListInventoriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_os_policy_assignment_reports requests.

This class thinly wraps an initial ListOSPolicyAssignmentReportsResponse object, and provides an __aiter__ method to iterate through its os_policy_assignment_reports field.

If there are more pages, the __aiter__ method will make additional ListOSPolicyAssignmentReports requests and continue to iterate through the os_policy_assignment_reports field on the corresponding responses.

All the usual ListOSPolicyAssignmentReportsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_os_policy_assignment_reports requests.

This class thinly wraps an initial ListOSPolicyAssignmentReportsResponse object, and provides an __iter__ method to iterate through its os_policy_assignment_reports field.

If there are more pages, the __iter__ method will make additional ListOSPolicyAssignmentReports requests and continue to iterate through the os_policy_assignment_reports field on the corresponding responses.

All the usual ListOSPolicyAssignmentReportsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_os_policy_assignment_revisions requests.

This class thinly wraps an initial ListOSPolicyAssignmentRevisionsResponse object, and provides an __aiter__ method to iterate through its os_policy_assignments field.

If there are more pages, the __aiter__ method will make additional ListOSPolicyAssignmentRevisions requests and continue to iterate through the os_policy_assignments field on the corresponding responses.

All the usual ListOSPolicyAssignmentRevisionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_os_policy_assignment_revisions requests.

This class thinly wraps an initial ListOSPolicyAssignmentRevisionsResponse object, and provides an __iter__ method to iterate through its os_policy_assignments field.

If there are more pages, the __iter__ method will make additional ListOSPolicyAssignmentRevisions requests and continue to iterate through the os_policy_assignments field on the corresponding responses.

All the usual ListOSPolicyAssignmentRevisionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_os_policy_assignments requests.

This class thinly wraps an initial ListOSPolicyAssignmentsResponse object, and provides an __aiter__ method to iterate through its os_policy_assignments field.

If there are more pages, the __aiter__ method will make additional ListOSPolicyAssignments requests and continue to iterate through the os_policy_assignments field on the corresponding responses.

All the usual ListOSPolicyAssignmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_os_policy_assignments requests.

This class thinly wraps an initial ListOSPolicyAssignmentsResponse object, and provides an __iter__ method to iterate through its os_policy_assignments field.

If there are more pages, the __iter__ method will make additional ListOSPolicyAssignments requests and continue to iterate through the os_policy_assignments field on the corresponding responses.

All the usual ListOSPolicyAssignmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_vulnerability_reports requests.

This class thinly wraps an initial ListVulnerabilityReportsResponse object, and provides an __aiter__ method to iterate through its vulnerability_reports field.

If there are more pages, the __aiter__ method will make additional ListVulnerabilityReports requests and continue to iterate through the vulnerability_reports field on the corresponding responses.

All the usual ListVulnerabilityReportsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_vulnerability_reports requests.

This class thinly wraps an initial ListVulnerabilityReportsResponse object, and provides an __iter__ method to iterate through its vulnerability_reports field.

If there are more pages, the __iter__ method will make additional ListVulnerabilityReports requests and continue to iterate through the vulnerability_reports field on the corresponding responses.

All the usual ListVulnerabilityReportsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Apt patching is completed by executing apt-get update && apt-get upgrade. Additional options can be set to control how this is executed.

Apt patch type.

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

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

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

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.

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

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

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

Message for canceling a patch job.

A request message to create an OS policy assignment

A request message for creating a patch deployment.

A request message for deleting a OS policy assignment.

A request message for deleting a patch deployment.

A step that runs an executable for a PatchJob.

Common configurations for an ExecStep.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The interpreter used to execute the a file.

A request message to initiate patching across Compute Engine instances.

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Cloud Storage object representation.

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

Get a report of the OS policy assignment for a VM instance.

A request message to get an OS policy assignment

A request message for retrieving a patch deployment.

Request to get an active or completed patch job.

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

Googet patching is performed by running googet update.

Namespace for instance state enums.

Patch state of an instance.

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 <https://cloud.google.com/compute/docs/instances/os-inventory-management#data-collected>__.

A single piece of inventory on a VM.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The origin of a specific inventory item.

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

The abstract base class for a message.

Operating system information for the VM.

Software package information of the operating system.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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

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

https://docs.microsoft.com/en-us/windows/win32/msi/uninstall-registry-key

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

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.

Categories specified by the Windows Update.

Details related to a Zypper Patch.

The view for inventory objects.

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

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

List the OS policy assignment reports for VM instances.

A response message for listing OS Policy assignment reports including the page of results and page token.

A request message to list revisions for a OS policy assignment

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

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

A response message for listing all assignments under given parent.

A request message for listing patch deployments.

A response message for listing patch deployments.

Request to list details for all instances that are part of a patch job.

A response message for listing the instances details for a patch job.

A request message for listing patch jobs.

A response message for listing patch jobs.

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

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

Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month".

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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

Filtering criteria to select VMs based on inventory details.

Policy mode

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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.

A file or script to execute.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The interpreter to use.

A remote or local file.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Specifies a file available as a Cloud Storage Object.

Specifies a file available via some URI.

A resource that manages the state of a file.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Desired state of the file.

A resource that manages a system package.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A package managed by APT.

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

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

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

A package managed by GooGet.

• install: googet -noconfirm install package
• remove: googet -noconfirm remove package

An MSI package. MSI packages only support INSTALLED state.

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

A package managed by YUM.

• install: yum -y install package
• remove: yum -y remove package

A package managed by Zypper.

• install: zypper -y install package
• remove: zypper -y rm package

A resource that manages a package repository.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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.

Type of archive.

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

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

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

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 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 <https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies>__.

Filters to select target VMs for an assignment.

If more than one filter criteria is specified below, a VM will be selected if and only if it satisfies all of them.

VM inventory details.

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.

The abstract base class for a message.

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

OS policy assignment rollout state

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

The OS policy assignment API method.

State of the rollout

A report of the OS policy assignment status for a given instance.

Compliance data for an OS policy

Possible compliance states for an os policy.

    Refer to the field `compliance_state_reason` to learn the
    exact reason for the policy to be in this compliance state.
COMPLIANT (1):
    Policy is compliant.

    The policy is compliant if all the underlying
    resources are also compliant.
NON_COMPLIANT (2):
    Policy is non-compliant.

    The policy is non-compliant if one or more
    underlying resources are non-compliant.

Compliance data for an OS policy resource.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Possible compliance states for a resource.

    To get more details about why the policy is in this state,
    review the output of the `compliance_state_reason` field.
COMPLIANT (1):
    Resource is compliant.
NON_COMPLIANT (2):
    Resource is non-compliant.

ExecResource specific output.

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

Supported configuration step types

    This step is used to determine the final desired
    state status for the resource. It accounts for
    any resources that might have drifted from their
    desired state due to side effects from executing
    other resources.

Sets the time for a one time patch deployment. Timestamp is in RFC3339 <https://www.ietf.org/rfc/rfc3339.txt>__ text format.

Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance.

Post-patch reboot settings.

Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see Scheduling patch jobs <https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs>__.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents state of patch peployment.

A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones.

Targets a group of VM instances by using their assigned labels <https://cloud.google.com/compute/docs/labeling-resources>__. Labels are key-value pairs. A GroupLabel is a combination of labels that is used to target VMs for a patch job.

For example, a patch job can target VMs that have the following GroupLabel: {"env":"test", "app":"web"}. This means that the patch job is applied to VMs that have both the labels env=test and app=web.

The abstract base class for a message.

A high level representation of a patch job that is either in progress or has completed.

Instance details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails.

For more information about patch jobs, see Creating patch jobs <https://cloud.google.com/compute/docs/os-patch-management/create-patch-job>__.

A summary of the current patch state across all instances that this patch job affects. Contains counts of instances in different states. These states map to InstancePatchState. List patch job instance details to see the specific states of each instance.

Enumeration of the various states a patch job passes through as it executes.

Patch details for a VM instance. For more information about reviewing VM instance details, see Listing all VM instance details for a specific patch job <https://cloud.google.com/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details>__.

Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs.

Type of the rollout.

A request message for pausing a patch deployment.

Sets the time for recurring patch deployments.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Specifies the frequency of the recurring patch deployments.

A request message for resuming a patch deployment.

A request message to update an OS policy assignment

A request message for updating a patch deployment.

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 <https://cloud.google.com/compute/docs/instances/os-inventory-management#vulnerability-reports>__.

A vulnerability affecting the VM instance.

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

A reference for this vulnerability.

OS inventory item that is affected by a vulnerability or fixed as a result of a vulnerability.

Represents one week day in a month. An example is "the 4th Sunday".

Represents a weekly schedule.

Windows patching is performed using the Windows Update Agent.

Microsoft Windows update classifications as defined in [1] https://support.microsoft.com/en-us/help/824684/description-of-the-standard-terminology-that-is-used-to-describe-micro

Yum patching is performed by executing yum update. Additional options can be set to control how this is executed.

Note that not all settings are supported on all platforms.

Zypper patching is performed by running zypper patch. See also https://en.opensuse.org/SDB:Zypper_manual.

Zonal OS Config API

The OS Config service is the server-side component that allows users to manage package installations and patch jobs for Compute Engine VM instances.

Zonal OS Config API

The OS Config service is the server-side component that allows users to manage package installations and patch jobs for Compute Engine VM instances.

A pager for iterating through list_instance_os_policies_compliances requests.

This class thinly wraps an initial ListInstanceOSPoliciesCompliancesResponse object, and provides an __aiter__ method to iterate through its instance_os_policies_compliances field.

If there are more pages, the __aiter__ method will make additional ListInstanceOSPoliciesCompliances requests and continue to iterate through the instance_os_policies_compliances field on the corresponding responses.

All the usual ListInstanceOSPoliciesCompliancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_instance_os_policies_compliances requests.

This class thinly wraps an initial ListInstanceOSPoliciesCompliancesResponse object, and provides an __iter__ method to iterate through its instance_os_policies_compliances field.

If there are more pages, the __iter__ method will make additional ListInstanceOSPoliciesCompliances requests and continue to iterate through the instance_os_policies_compliances field on the corresponding responses.

All the usual ListInstanceOSPoliciesCompliancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_inventories requests.

This class thinly wraps an initial ListInventoriesResponse object, and provides an __aiter__ method to iterate through its inventories field.

If there are more pages, the __aiter__ method will make additional ListInventories requests and continue to iterate through the inventories field on the corresponding responses.

All the usual ListInventoriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_inventories requests.

This class thinly wraps an initial ListInventoriesResponse object, and provides an __iter__ method to iterate through its inventories field.

If there are more pages, the __iter__ method will make additional ListInventories requests and continue to iterate through the inventories field on the corresponding responses.

All the usual ListInventoriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_os_policy_assignment_reports requests.

This class thinly wraps an initial ListOSPolicyAssignmentReportsResponse object, and provides an __aiter__ method to iterate through its os_policy_assignment_reports field.

If there are more pages, the __aiter__ method will make additional ListOSPolicyAssignmentReports requests and continue to iterate through the os_policy_assignment_reports field on the corresponding responses.

All the usual ListOSPolicyAssignmentReportsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_os_policy_assignment_reports requests.

This class thinly wraps an initial ListOSPolicyAssignmentReportsResponse object, and provides an __iter__ method to iterate through its os_policy_assignment_reports field.

If there are more pages, the __iter__ method will make additional ListOSPolicyAssignmentReports requests and continue to iterate through the os_policy_assignment_reports field on the corresponding responses.

All the usual ListOSPolicyAssignmentReportsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_os_policy_assignment_revisions requests.

This class thinly wraps an initial ListOSPolicyAssignmentRevisionsResponse object, and provides an __aiter__ method to iterate through its os_policy_assignments field.

If there are more pages, the __aiter__ method will make additional ListOSPolicyAssignmentRevisions requests and continue to iterate through the os_policy_assignments field on the corresponding responses.

All the usual ListOSPolicyAssignmentRevisionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_os_policy_assignment_revisions requests.

This class thinly wraps an initial ListOSPolicyAssignmentRevisionsResponse object, and provides an __iter__ method to iterate through its os_policy_assignments field.

If there are more pages, the __iter__ method will make additional ListOSPolicyAssignmentRevisions requests and continue to iterate through the os_policy_assignments field on the corresponding responses.

All the usual ListOSPolicyAssignmentRevisionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_os_policy_assignments requests.

This class thinly wraps an initial ListOSPolicyAssignmentsResponse object, and provides an __aiter__ method to iterate through its os_policy_assignments field.

If there are more pages, the __aiter__ method will make additional ListOSPolicyAssignments requests and continue to iterate through the os_policy_assignments field on the corresponding responses.

All the usual ListOSPolicyAssignmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_os_policy_assignments requests.

This class thinly wraps an initial ListOSPolicyAssignmentsResponse object, and provides an __iter__ method to iterate through its os_policy_assignments field.

If there are more pages, the __iter__ method will make additional ListOSPolicyAssignments requests and continue to iterate through the os_policy_assignments field on the corresponding responses.

All the usual ListOSPolicyAssignmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_vulnerability_reports requests.

This class thinly wraps an initial ListVulnerabilityReportsResponse object, and provides an __aiter__ method to iterate through its vulnerability_reports field.

If there are more pages, the __aiter__ method will make additional ListVulnerabilityReports requests and continue to iterate through the vulnerability_reports field on the corresponding responses.

All the usual ListVulnerabilityReportsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_vulnerability_reports requests.

This class thinly wraps an initial ListVulnerabilityReportsResponse object, and provides an __iter__ method to iterate through its vulnerability_reports field.

If there are more pages, the __iter__ method will make additional ListVulnerabilityReports requests and continue to iterate through the vulnerability_reports field on the corresponding responses.

All the usual ListVulnerabilityReportsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

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

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

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

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.

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

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

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

A request message to create an OS policy assignment

A request message for deleting a OS policy assignment.

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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

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

Get a report of the OS policy assignment for a VM instance.

A request message to get an OS policy assignment

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

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 <https://cloud.google.com/compute/docs/os-configuration-management/view-compliance>__.

Compliance data for an OS policy

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 <https://cloud.google.com/compute/docs/instances/os-inventory-management#data-collected>__.

A single piece of inventory on a VM.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The origin of a specific inventory item.

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

The abstract base class for a message.

Operating system information for the VM.

Software package information of the operating system.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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

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

https://docs.microsoft.com/en-us/windows/win32/msi/uninstall-registry-key

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

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.

Categories specified by the Windows Update.

Details related to a Zypper Patch.

The view for inventory objects.

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

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

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

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

List the OS policy assignment reports for VM instances.

A response message for listing OS Policy assignment reports including the page of results and page token.

A request message to list revisions for a OS policy assignment

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

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

A response message for listing all assignments under given parent.

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

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

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

Filtering criteria to select VMs based on inventory details.

Policy mode

Filtering criteria to select VMs based on OS details.

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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.

A file or script to execute.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The interpreter to use.

A remote or local file.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Specifies a file available as a Cloud Storage Object.

Specifies a file available via some URI.

A resource that manages the state of a file.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Desired state of the file.

A resource that manages a system package.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A package managed by APT.

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

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

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

A package managed by GooGet.

• install: googet -noconfirm install package
• remove: googet -noconfirm remove package

An MSI package. MSI packages only support INSTALLED state.

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

A package managed by YUM.

• install: yum -y install package
• remove: yum -y remove package

A package managed by Zypper.

• install: zypper -y install package
• remove: zypper -y rm package

A resource that manages a package repository.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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.

Type of archive.

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

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

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

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 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 <https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies>__.

Filters to select target VMs for an assignment.

If more than one filter criteria is specified below, a VM will be selected if and only if it satisfies all of them.

VM inventory details.

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.

The abstract base class for a message.

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

OS policy assignment rollout state

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

The OS policy assignment API method.

State of the rollout

A report of the OS policy assignment status for a given instance.

Compliance data for an OS policy

Possible compliance states for an os policy.

    Refer to the field `compliance_state_reason` to learn the
    exact reason for the policy to be in this compliance state.
COMPLIANT (1):
    Policy is compliant.

    The policy is compliant if all the underlying
    resources are also compliant.
NON_COMPLIANT (2):
    Policy is non-compliant.

    The policy is non-compliant if one or more
    underlying resources are non-compliant.

Compliance data for an OS policy resource.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Possible compliance states for a resource.

    To get more details about why the policy is in this state,
    review the output of the `compliance_state_reason` field.
COMPLIANT (1):
    Resource is compliant.
NON_COMPLIANT (2):
    Resource is non-compliant.

ExecResource specific output.

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

Supported configuration step types

    This step is used to determine the final desired
    state status for the resource. It accounts for
    any resources that might have drifted from their
    desired state due to side effects from executing
    other resources.

Supported OSPolicy compliance states.

Compliance data for an OS policy resource.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ExecResource specific output.

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

Supported outcomes for a configuration step.

Supported configuration step types

    This step is used to determine the final desired
    state status for the resource. It accounts for
    any resources that might have drifted from their
    desired state due to side effects from
    configuring other resources during the current
    configuration run.

A request message to update an OS policy assignment

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 <https://cloud.google.com/compute/docs/instances/os-inventory-management#vulnerability-reports>__.

A vulnerability affecting the VM instance.

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

A reference for this vulnerability.

OS inventory item that is affected by a vulnerability or fixed as a result of a vulnerability.

API documentation for osconfig_v1.services.os_config_service.pagers module.

API documentation for osconfig_v1.services.os_config_zonal_service.pagers module.

API documentation for osconfig_v1alpha.services.os_config_zonal_service.pagers module.