osconfig/v1alpha library

OS Config API - v1alpha

OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.

For more information, see cloud.google.com/compute/docs/osconfig/rest

Create an instance of OSConfigApi to access these resources:

• ProjectsResource
  • ProjectsLocationsResource
    • ProjectsLocationsInstanceOSPoliciesCompliancesResource
    • ProjectsLocationsInstancesResource
      • ProjectsLocationsInstancesInventoriesResource
      • ProjectsLocationsInstancesVulnerabilityReportsResource
    • ProjectsLocationsOsPolicyAssignmentsResource
      • ProjectsLocationsOsPolicyAssignmentsOperationsResource

Classes

CancelOperationRequest

The request message for Operations.CancelOperation.

CVSSv3

Common Vulnerability Scoring System version 3.

Date

Represents a whole or partial calendar date, such as a birthday.

Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.

FixedOrPercent

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

InstanceOSPoliciesCompliance

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

InstanceOSPoliciesComplianceOSPolicyCompliance

Compliance data for an OS policy

Inventory

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

InventoryItem

A single piece of inventory on a VM.

InventoryOsInfo

Operating system information for the VM.

InventorySoftwarePackage

Software package information of the operating system.

InventoryVersionedPackage

Information related to the a standard versioned package.

InventoryWindowsApplication

Contains information about a Windows application as retrieved from the Windows Registry.

InventoryWindowsQuickFixEngineeringPackage

Information related to a Quick Fix Engineering package.

InventoryWindowsUpdatePackage

Details related to a Windows Update package.

InventoryWindowsUpdatePackageWindowsUpdateCategory

Categories specified by the Windows Update.

InventoryZypperPatch

Details related to a Zypper Patch.

ListInstanceOSPoliciesCompliancesResponse

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

ListInventoriesResponse

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

ListOSPolicyAssignmentRevisionsResponse

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

ListOSPolicyAssignmentsResponse

A response message for listing all assignments under given parent.

ListVulnerabilityReportsResponse

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

Operation

This resource represents a long-running operation that is the result of a network API call.

OSConfigApi

OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.

OSPolicy

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

OSPolicyAssignment

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.

OSPolicyAssignmentInstanceFilter

Filters to select target VMs for an assignment.

OSPolicyAssignmentInstanceFilterInventory

VM inventory details.

OSPolicyAssignmentLabelSet

Message representing label set.

OSPolicyAssignmentOperationMetadata

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

OSPolicyAssignmentRollout

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

OSPolicyInventoryFilter

Filtering criteria to select VMs based on inventory details.

OSPolicyOSFilter

Filtering criteria to select VMs based on OS details.

OSPolicyResource

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.

OSPolicyResourceCompliance

Compliance data for an OS policy resource.

OSPolicyResourceComplianceExecResourceOutput

ExecResource specific output.

OSPolicyResourceConfigStep

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

OSPolicyResourceExecResource

A resource that allows executing scripts on the VM.

OSPolicyResourceExecResourceExec

A file or script to execute.

OSPolicyResourceFile

A remote or local file.

OSPolicyResourceFileGcs

Specifies a file available as a Cloud Storage Object.

OSPolicyResourceFileRemote

Specifies a file available via some URI.

OSPolicyResourceFileResource

A resource that manages the state of a file.

OSPolicyResourceGroup

Resource groups provide a mechanism to group OS policy resources.

OSPolicyResourcePackageResource

A resource that manages a system package.

OSPolicyResourcePackageResourceAPT

A package managed by APT.

OSPolicyResourcePackageResourceDeb

A deb package file.

OSPolicyResourcePackageResourceGooGet

A package managed by GooGet.

OSPolicyResourcePackageResourceMSI

An MSI package.

OSPolicyResourcePackageResourceRPM

An RPM package file.

OSPolicyResourcePackageResourceYUM

A package managed by YUM.

OSPolicyResourcePackageResourceZypper

A package managed by Zypper.

OSPolicyResourceRepositoryResource

A resource that manages a package repository.

OSPolicyResourceRepositoryResourceAptRepository

Represents a single apt package repository.

OSPolicyResourceRepositoryResourceGooRepository

Represents a Goo package repository.

OSPolicyResourceRepositoryResourceYumRepository

Represents a single yum package repository.

OSPolicyResourceRepositoryResourceZypperRepository

Represents a single zypper package repository.

ProjectsLocationsInstanceOSPoliciesCompliancesResource

ProjectsLocationsInstancesInventoriesResource

ProjectsLocationsInstancesResource

ProjectsLocationsInstancesVulnerabilityReportsResource

ProjectsLocationsOsPolicyAssignmentsOperationsResource

ProjectsLocationsOsPolicyAssignmentsResource

ProjectsLocationsResource

ProjectsResource

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.

VulnerabilityReport

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

VulnerabilityReportVulnerability

A vulnerability affecting the VM instance.

VulnerabilityReportVulnerabilityDetails

Contains metadata information for the vulnerability.

VulnerabilityReportVulnerabilityDetailsReference

A reference for this vulnerability.

Exceptions / Errors

ApiRequestError

Represents a general error reported by the API endpoint.

DetailedApiRequestError

Represents a specific error reported by the API endpoint.