Namespace Google.Apis.OSConfig.v1alpha.Data

Classes

CVSSv3

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

CancelOperationRequest

The request message for Operations.CancelOperation.

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

FixedOrPercent

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

GoogleCloudOsconfigV1OSPolicyAssignmentOperationMetadata

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

GoogleCloudOsconfigV2betaOperationMetadata

Represents the metadata of the long-running operation.

InstanceOSPoliciesCompliance

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.

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. You can use this API resource to determine the inventory data of your VM. For more information, see Information provided by OS inventory management.

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. This includes package info for APT, Yum, Zypper, and Googet package managers.

InventoryWindowsApplication

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

InventoryWindowsQuickFixEngineeringPackage

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

InventoryWindowsUpdatePackage

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.

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.

ListOSPolicyAssignmentReportsResponse

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

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.

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. 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.

OSPolicyAssignmentInstanceFilter

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.

OSPolicyAssignmentInstanceFilterInventory

VM inventory details.

OSPolicyAssignmentLabelSet

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.

OSPolicyAssignmentOperationMetadata

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

OSPolicyAssignmentReport

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

OSPolicyAssignmentReportOSPolicyCompliance

Compliance data for an OS policy

OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceCompliance

Compliance data for an OS policy resource.

OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceExecResourceOutput

ExecResource specific output.

OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceOSPolicyResourceConfigStep

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

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. The system ensures that resources are always in their desired state by taking necessary actions if they have drifted from their desired state.

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. 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.

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. 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.

OSPolicyResourcePackageResource

A resource that manages a system package.

OSPolicyResourcePackageResourceAPT

A package managed by APT. - install: apt-get update && apt-get -y install [name] - remove: apt-get -y remove [name]

OSPolicyResourcePackageResourceDeb

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

OSPolicyResourcePackageResourceGooGet

A package managed by GooGet. - install: googet -noconfirm install package - remove: googet -noconfirm remove package

OSPolicyResourcePackageResourceMSI

An MSI package. MSI packages only support INSTALLED state.

OSPolicyResourcePackageResourceRPM

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

OSPolicyResourcePackageResourceYUM

A package managed by YUM. - install: yum -y install package - remove: yum -y remove package

OSPolicyResourcePackageResourceZypper

A package managed by Zypper. - install: zypper -y install package - remove: zypper -y rm package

OSPolicyResourceRepositoryResource

A resource that manages a package repository.

OSPolicyResourceRepositoryResourceAptRepository

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.

OSPolicyResourceRepositoryResourceGooRepository

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

OSPolicyResourceRepositoryResourceYumRepository

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

OSPolicyResourceRepositoryResourceZypperRepository

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

Operation

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

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.