Show / Hide Table of Contents

Namespace Google.Apis.OSConfig.v1beta.Data

Classes

AptRepository

Represents a single Apt package repository. This repository is added to a repo file that is stored at /etc/apt/sources.list.d/google_osconfig.list.

AptSettings

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

Assignment

An assignment represents the group or groups of VM instances that the policy applies to. If an assignment is empty, it applies to all VM instances. Otherwise, the targeted VM instances must meet all the criteria specified. So if both labels and zones are specified, the policy applies to VM instances with those labels and in those zones.

AssignmentGroupLabel

Represents a group of VM intances that can be identified as having all these labels, for example "env=prod and app=web".

AssignmentOsType

Defines the criteria for selecting VM Instances by OS type.

CancelPatchJobRequest

Message for canceling a patch job.

EffectiveGuestPolicy

The effective guest policy that applies to a VM instance.

EffectiveGuestPolicySourcedPackage

A guest policy package including its source.

EffectiveGuestPolicySourcedPackageRepository

A guest policy package repository including its source.

EffectiveGuestPolicySourcedSoftwareRecipe

A guest policy recipe including its source.

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); }

ExecStep

A step that runs an executable for a PatchJob.

ExecStepConfig

Common configurations for an ExecStep.

ExecutePatchJobRequest

A request message to initiate patching across Compute Engine instances.

FixedOrPercent

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

GcsObject

Google Cloud Storage object representation.

GoogleCloudOsconfigV1OSPolicyAssignmentOperationMetadata

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

GooRepository

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

GooSettings

Googet patching is performed by running googet update.

GuestPolicy

An OS Config resource representing a guest configuration policy. These policies represent the desired state for VM instance guest environments including packages to install or remove, package repository configurations, and software to install.

ListGuestPoliciesResponse

A response message for listing guest policies.

ListPatchDeploymentsResponse

A response message for listing patch deployments.

ListPatchJobInstanceDetailsResponse

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

ListPatchJobsResponse

A response message for listing patch jobs.

LookupEffectiveGuestPolicyRequest

A request message for getting the effective guest policy assigned to the instance.

MonthlySchedule

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

OneTimeSchedule

Sets the time for a one time patch deployment. Timestamp is in RFC3339 text format.

OSPolicyAssignmentOperationMetadata

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

Package

Package is a reference to the software package to be installed or removed. The agent on the VM instance uses the system package manager to apply the config. These are the commands that the agent uses to install or remove packages. Apt install: apt-get update && apt-get -y install package1 package2 package3 remove: apt-get -y remove package1 package2 package3 Yum install: yum -y install package1 package2 package3 remove: yum -y remove package1 package2 package3 Zypper install: zypper install package1 package2 package3 remove: zypper rm package1 package2 Googet install: googet -noconfirm install package1 package2 package3 remove: googet -noconfirm remove package1 package2 package3

PackageRepository

A package repository.

PatchConfig

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

PatchDeployment

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.

PatchInstanceFilter

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.

PatchInstanceFilterGroupLabel

Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web".

PatchJob

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.

PatchJobInstanceDetails

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.

PatchJobInstanceDetailsSummary

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.

PatchRollout

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

PausePatchDeploymentRequest

A request message for pausing a patch deployment.

RecurringSchedule

Sets the time for recurring patch deployments.

ResumePatchDeploymentRequest

A request message for resuming a patch deployment.

SoftwareRecipe

A software recipe is a set of instructions for installing and configuring a piece of software. It consists of a set of artifacts that are downloaded, and a set of steps that install, configure, and/or update the software. Recipes support installing and updating software from artifacts in the following formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. Additionally, recipes support executing a script (either defined in a file or directly in this api) in bash, sh, cmd, and powershell. Updating a software recipe If a recipe is assigned to an instance and there is a recipe with the same name but a lower version already installed and the assigned state of the recipe is UPDATED, then the recipe is updated to the new version. Script Working Directories Each script or execution step is run in its own temporary directory which is deleted after completing the step.

SoftwareRecipeArtifact

Specifies a resource to be used in the recipe.

SoftwareRecipeArtifactGcs

Specifies an artifact available as a Google Cloud Storage object.

SoftwareRecipeArtifactRemote

Specifies an artifact available via some URI.

SoftwareRecipeStep

An action that can be taken as part of installing or updating a recipe.

SoftwareRecipeStepCopyFile

Copies the artifact to the specified path on the instance.

SoftwareRecipeStepExecFile

Executes an artifact or local file.

SoftwareRecipeStepExtractArchive

Extracts an archive of the type specified in the specified directory.

SoftwareRecipeStepInstallDpkg

Installs a deb via dpkg.

SoftwareRecipeStepInstallMsi

Installs an MSI file.

SoftwareRecipeStepInstallRpm

Installs an rpm file via the rpm utility.

SoftwareRecipeStepRunScript

Runs a script through an interpreter.

TimeOfDay

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

TimeZone

Represents a time zone from the IANA Time Zone Database.

WeekDayOfMonth

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

WeeklySchedule

Represents a weekly schedule.

WindowsUpdateSettings

Windows patching is performed using the Windows Update Agent.

YumRepository

Represents a single Yum package repository. This repository is added to a repo file that is stored at /etc/yum.repos.d/google_osconfig.repo.

YumSettings

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.

ZypperRepository

Represents a single Zypper package repository. This repository is added to a repo file that is stored at /etc/zypp/repos.d/google_osconfig.repo.

ZypperSettings

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

In This Article
Back to top