Google Git
Sign in
chromium / external / github.com / google / google-api-python-client / refs/heads/release-v1.13.0 / . / googleapiclient / discovery_cache / documents / osconfig.v1beta.json
blob: 8e0ffff2056b4239f2d1929ada976f430070febe [file] [log] [blame] [edit]
{
"batchPath": "batch",
"description": "OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.",
"revision": "20201112",
"id": "osconfig:v1beta",
"baseUrl": "https://osconfig.googleapis.com/",
"version": "v1beta",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"servicePath": "",
"rootUrl": "https://osconfig.googleapis.com/",
"resources": {
"projects": {
"resources": {
"zones": {
"resources": {
"instances": {
"methods": {
"lookupEffectiveGuestPolicy": {
"parameterOrder": [
"instance"
],
"description": "Lookup the effective guest policy that applies to a VM instance. This lookup merges all policies that are assigned to the instance ancestry.",
"id": "osconfig.projects.zones.instances.lookupEffectiveGuestPolicy",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "POST",
"request": {
"$ref": "LookupEffectiveGuestPolicyRequest"
},
"flatPath": "v1beta/projects/{projectsId}/zones/{zonesId}/instances/{instancesId}:lookupEffectiveGuestPolicy",
"parameters": {
"instance": {
"pattern": "^projects/[^/]+/zones/[^/]+/instances/[^/]+$",
"required": true,
"location": "path",
"type": "string",
"description": "Required. The VM instance whose policies are being looked up."
}
},
"path": "v1beta/{+instance}:lookupEffectiveGuestPolicy",
"response": {
"$ref": "EffectiveGuestPolicy"
}
}
}
}
}
},
"patchDeployments": {
"methods": {
"create": {
"request": {
"$ref": "PatchDeployment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"required": true,
"location": "path",
"type": "string",
"description": "Required. The project to apply this patch deployment to in the form `projects/*`.",
"pattern": "^projects/[^/]+$"
},
"patchDeploymentId": {
"description": "Required. A name for the patch deployment in the project. When creating a name the following rules apply: * 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": "string",
"location": "query"
}
},
"path": "v1beta/{+parent}/patchDeployments",
"id": "osconfig.projects.patchDeployments.create",
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"response": {
"$ref": "PatchDeployment"
},
"description": "Create an OS Config patch deployment.",
"flatPath": "v1beta/projects/{projectsId}/patchDeployments"
},
"delete": {
"parameters": {
"name": {
"pattern": "^projects/[^/]+/patchDeployments/[^/]+$",
"type": "string",
"description": "Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.",
"required": true,
"location": "path"
}
},
"httpMethod": "DELETE",
"id": "osconfig.projects.patchDeployments.delete",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"description": "Delete an OS Config patch deployment.",
"flatPath": "v1beta/projects/{projectsId}/patchDeployments/{patchDeploymentsId}",
"path": "v1beta/{+name}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "ListPatchDeploymentsResponse"
},
"id": "osconfig.projects.patchDeployments.list",
"parameterOrder": [
"parent"
],
"path": "v1beta/{+parent}/patchDeployments",
"parameters": {
"parent": {
"type": "string",
"location": "path",
"required": true,
"description": "Required. The resource name of the parent in the form `projects/*`.",
"pattern": "^projects/[^/]+$"
},
"pageToken": {
"location": "query",
"description": "Optional. A pagination token returned from a previous call to ListPatchDeployments that indicates where this listing should continue from.",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of patch deployments to return. Default is 100.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"description": "Get a page of OS Config patch deployments.",
"httpMethod": "GET",
"flatPath": "v1beta/projects/{projectsId}/patchDeployments"
},
"get": {
"path": "v1beta/{+name}",
"parameters": {
"name": {
"location": "path",
"description": "Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/patchDeployments/[^/]+$"
}
},
"flatPath": "v1beta/projects/{projectsId}/patchDeployments/{patchDeploymentsId}",
"httpMethod": "GET",
"response": {
"$ref": "PatchDeployment"
},
"description": "Get an OS Config patch deployment.",
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "osconfig.projects.patchDeployments.get"
}
}
},
"patchJobs": {
"resources": {
"instanceDetails": {
"methods": {
"list": {
"id": "osconfig.projects.patchJobs.instanceDetails.list",
"response": {
"$ref": "ListPatchJobInstanceDetailsResponse"
},
"parameters": {
"pageToken": {
"location": "query",
"type": "string",
"description": "A pagination token returned from a previous call that indicates where this listing should continue from."
},
"parent": {
"type": "string",
"location": "path",
"description": "Required. The parent for the instances are in the form of `projects/*/patchJobs/*`.",
"pattern": "^projects/[^/]+/patchJobs/[^/]+$",
"required": true
},
"filter": {
"description": "A filter expression that filters results listed in the response. This field supports filtering results by instance zone, name, state, or `failure_reason`.",
"location": "query",
"type": "string"
},
"pageSize": {
"type": "integer",
"description": "The maximum number of instance details records to return. Default is 100.",
"format": "int32",
"location": "query"
}
},
"description": "Get a list of instance details for a given patch job.",
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"path": "v1beta/{+parent}/instanceDetails",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta/projects/{projectsId}/patchJobs/{patchJobsId}/instanceDetails"
}
}
}
},
"methods": {
"execute": {
"description": "Patch VM instances by creating and running a patch job.",
"path": "v1beta/{+parent}/patchJobs:execute",
"parameters": {
"parent": {
"pattern": "^projects/[^/]+$",
"description": "Required. The project in which to run this patch in the form `projects/*`",
"location": "path",
"type": "string",
"required": true
}
},
"id": "osconfig.projects.patchJobs.execute",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "PatchJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "POST",
"request": {
"$ref": "ExecutePatchJobRequest"
},
"flatPath": "v1beta/projects/{projectsId}/patchJobs:execute"
},
"get": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1beta/{+name}",
"parameterOrder": [
"name"
],
"id": "osconfig.projects.patchJobs.get",
"flatPath": "v1beta/projects/{projectsId}/patchJobs/{patchJobsId}",
"response": {
"$ref": "PatchJob"
},
"parameters": {
"name": {
"description": "Required. Name of the patch in the form `projects/*/patchJobs/*`",
"type": "string",
"pattern": "^projects/[^/]+/patchJobs/[^/]+$",
"required": true,
"location": "path"
}
},
"httpMethod": "GET",
"description": "Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs."
},
"list": {
"id": "osconfig.projects.patchJobs.list",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"pageSize": {
"location": "query",
"format": "int32",
"description": "The maximum number of instance status to return.",
"type": "integer"
},
"filter": {
"location": "query",
"description": "If provided, this field specifies the criteria that must be met by patch jobs to be included in the response. Currently, filtering is only available on the patch_deployment field.",
"type": "string"
},
"pageToken": {
"location": "query",
"type": "string",
"description": "A pagination token returned from a previous call that indicates where this listing should continue from."
},
"parent": {
"description": "Required. In the form of `projects/*`",
"required": true,
"pattern": "^projects/[^/]+$",
"type": "string",
"location": "path"
}
},
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"flatPath": "v1beta/projects/{projectsId}/patchJobs",
"path": "v1beta/{+parent}/patchJobs",
"description": "Get a list of patch jobs.",
"response": {
"$ref": "ListPatchJobsResponse"
}
},
"cancel": {
"parameters": {
"name": {
"required": true,
"type": "string",
"description": "Required. Name of the patch in the form `projects/*/patchJobs/*`",
"location": "path",
"pattern": "^projects/[^/]+/patchJobs/[^/]+$"
}
},
"path": "v1beta/{+name}:cancel",
"flatPath": "v1beta/projects/{projectsId}/patchJobs/{patchJobsId}:cancel",
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "PatchJob"
},
"httpMethod": "POST",
"request": {
"$ref": "CancelPatchJobRequest"
},
"description": "Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.",
"id": "osconfig.projects.patchJobs.cancel"
}
}
},
"guestPolicies": {
"methods": {
"patch": {
"id": "osconfig.projects.guestPolicies.patch",
"description": "Update an OS Config guest policy.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"request": {
"$ref": "GuestPolicy"
},
"response": {
"$ref": "GuestPolicy"
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"path": "v1beta/{+name}",
"parameters": {
"updateMask": {
"format": "google-fieldmask",
"location": "query",
"type": "string",
"description": "Field mask that controls which fields of the guest policy should be updated."
},
"name": {
"type": "string",
"description": "Required. Unique name of the resource in this project using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`.",
"pattern": "^projects/[^/]+/guestPolicies/[^/]+$",
"required": true,
"location": "path"
}
},
"flatPath": "v1beta/projects/{projectsId}/guestPolicies/{guestPoliciesId}"
},
"list": {
"flatPath": "v1beta/projects/{projectsId}/guestPolicies",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "osconfig.projects.guestPolicies.list",
"path": "v1beta/{+parent}/guestPolicies",
"response": {
"$ref": "ListGuestPoliciesResponse"
},
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"description": "Get a page of OS Config guest policies.",
"parameters": {
"parent": {
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "Required. The resource name of the parent using one of the following forms: `projects/{project_number}`.",
"type": "string",
"required": true
},
"pageToken": {
"location": "query",
"type": "string",
"description": "A pagination token returned from a previous call to `ListGuestPolicies` that indicates where this listing should continue from."
},
"pageSize": {
"type": "integer",
"description": "The maximum number of guest policies to return.",
"format": "int32",
"location": "query"
}
}
},
"get": {
"path": "v1beta/{+name}",
"id": "osconfig.projects.guestPolicies.get",
"description": "Get an OS Config guest policy.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta/projects/{projectsId}/guestPolicies/{guestPoliciesId}",
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"location": "path",
"type": "string",
"required": true,
"description": "Required. The resource name of the guest policy using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`.",
"pattern": "^projects/[^/]+/guestPolicies/[^/]+$"
}
},
"response": {
"$ref": "GuestPolicy"
}
},
"create": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Create an OS Config guest policy.",
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"parameters": {
"guestPolicyId": {
"location": "query",
"description": "Required. The logical name of the guest policy 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": "string"
},
"parent": {
"location": "path",
"pattern": "^projects/[^/]+$",
"description": "Required. The resource name of the parent using one of the following forms: `projects/{project_number}`.",
"type": "string",
"required": true
}
},
"flatPath": "v1beta/projects/{projectsId}/guestPolicies",
"request": {
"$ref": "GuestPolicy"
},
"response": {
"$ref": "GuestPolicy"
},
"path": "v1beta/{+parent}/guestPolicies",
"id": "osconfig.projects.guestPolicies.create"
},
"delete": {
"id": "osconfig.projects.guestPolicies.delete",
"path": "v1beta/{+name}",
"flatPath": "v1beta/projects/{projectsId}/guestPolicies/{guestPoliciesId}",
"parameters": {
"name": {
"location": "path",
"pattern": "^projects/[^/]+/guestPolicies/[^/]+$",
"required": true,
"description": "Required. The resource name of the guest policy using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "Empty"
},
"httpMethod": "DELETE",
"parameterOrder": [
"name"
],
"description": "Delete an OS Config guest policy."
}
}
}
}
}
},
"kind": "discovery#restDescription",
"canonicalName": "OS Config",
"version_module": true,
"ownerDomain": "google.com",
"basePath": "",
"name": "osconfig",
"parameters": {
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"upload_protocol": {
"type": "string",
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
"prettyPrint": {
"location": "query",
"type": "boolean",
"description": "Returns response with indentations and line breaks.",
"default": "true"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
"location": "query"
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user.",
"location": "query"
},
"alt": {
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"type": "string",
"enum": [
"json",
"media",
"proto"
],
"default": "json",
"description": "Data format for response.",
"location": "query"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"type": "string",
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format."
},
"key": {
"type": "string",
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"fields": {
"type": "string",
"location": "query",
"description": "Selector specifying which fields to include in a partial response."
}
},
"ownerName": "Google",
"title": "OS Config API",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"schemas": {
"FixedOrPercent": {
"properties": {
"percent": {
"type": "integer",
"description": "Specifies the relative value defined as a percentage, which will be multiplied by a reference value.",
"format": "int32"
},
"fixed": {
"format": "int32",
"description": "Specifies a fixed value.",
"type": "integer"
}
},
"description": "Message encapsulating a value that can be either absolute (\"fixed\") or relative (\"percent\") to a value.",
"type": "object",
"id": "FixedOrPercent"
},
"EffectiveGuestPolicySourcedPackageRepository": {
"id": "EffectiveGuestPolicySourcedPackageRepository",
"type": "object",
"description": "A guest policy package repository including its source.",
"properties": {
"packageRepository": {
"$ref": "PackageRepository",
"description": "A software package repository to configure on the VM instance."
},
"source": {
"type": "string",
"description": "Name of the guest policy providing this config."
}
}
},
"PatchConfig": {
"properties": {
"apt": {
"description": "Apt update settings. Use this setting to override the default `apt` patch rules.",
"$ref": "AptSettings"
},
"preStep": {
"$ref": "ExecStep",
"description": "The `ExecStep` to run before the patch update."
},
"goo": {
"$ref": "GooSettings",
"description": "Goo update settings. Use this setting to override the default `goo` patch rules."
},
"yum": {
"$ref": "YumSettings",
"description": "Yum update settings. Use this setting to override the default `yum` patch rules."
},
"rebootConfig": {
"description": "Post-patch reboot settings.",
"type": "string",
"enum": [
"REBOOT_CONFIG_UNSPECIFIED",
"DEFAULT",
"ALWAYS",
"NEVER"
],
"enumDescriptions": [
"The default behavior is DEFAULT.",
"The agent decides if a reboot is necessary by checking signals such as registry keys on Windows or `/var/run/reboot-required` on APT based systems. On RPM based systems, a set of core system package install times are compared with system boot time.",
"Always reboot the machine after the update completes.",
"Never reboot the machine after the update completes."
]
},
"postStep": {
"description": "The `ExecStep` to run after the patch update.",
"$ref": "ExecStep"
},
"zypper": {
"$ref": "ZypperSettings",
"description": "Zypper update settings. Use this setting to override the default `zypper` patch rules."
},
"windowsUpdate": {
"$ref": "WindowsUpdateSettings",
"description": "Windows update settings. Use this override the default windows patch rules."
}
},
"description": "Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance.",
"id": "PatchConfig",
"type": "object"
},
"PackageRepository": {
"id": "PackageRepository",
"properties": {
"zypper": {
"$ref": "ZypperRepository",
"description": "A Zypper Repository."
},
"goo": {
"$ref": "GooRepository",
"description": "A Goo Repository."
},
"apt": {
"description": "An Apt Repository.",
"$ref": "AptRepository"
},
"yum": {
"description": "A Yum Repository.",
"$ref": "YumRepository"
}
},
"description": "A package repository.",
"type": "object"
},
"AssignmentOsType": {
"id": "AssignmentOsType",
"properties": {
"osVersion": {
"description": "Targets VM instances with OS Inventory enabled and having the following following OS version.",
"type": "string"
},
"osShortName": {
"description": "Targets VM instances with OS Inventory enabled and having the following OS short name, for example \"debian\" or \"windows\".",
"type": "string"
},
"osArchitecture": {
"description": "Targets VM instances with OS Inventory enabled and having the following OS architecture.",
"type": "string"
}
},
"type": "object",
"description": "Defines the criteria for selecting VM Instances by OS type."
},
"PatchJobInstanceDetails": {
"id": "PatchJobInstanceDetails",
"type": "object",
"description": "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).",
"properties": {
"instanceSystemId": {
"description": "The unique identifier for the instance. This identifier is defined by the server.",
"type": "string"
},
"failureReason": {
"type": "string",
"description": "If the patch fails, this field provides the reason."
},
"name": {
"type": "string",
"description": "The instance name in the form `projects/*/zones/*/instances/*`"
},
"state": {
"type": "string",
"enumDescriptions": [
"Unspecified.",
"The instance is not yet notified.",
"Instance is inactive and cannot be patched.",
"The instance is notified that it should be patched.",
"The instance has started the patching process.",
"The instance is downloading patches.",
"The instance is applying patches.",
"The instance is rebooting.",
"The instance has completed applying patches.",
"The instance has completed applying patches but a reboot is required.",
"The instance has failed to apply the patch.",
"The instance acked the notification and will start shortly.",
"The instance exceeded the time out while applying the patch.",
"The instance is running the pre-patch step.",
"The instance is running the post-patch step.",
"The service could not detect the presence of the agent. Check to ensure that the agent is installed, running, and able to communicate with the service."
],
"enum": [
"PATCH_STATE_UNSPECIFIED",
"PENDING",
"INACTIVE",
"NOTIFIED",
"STARTED",
"DOWNLOADING_PATCHES",
"APPLYING_PATCHES",
"REBOOTING",
"SUCCEEDED",
"SUCCEEDED_REBOOT_REQUIRED",
"FAILED",
"ACKED",
"TIMED_OUT",
"RUNNING_PRE_PATCH_STEP",
"RUNNING_POST_PATCH_STEP",
"NO_AGENT_DETECTED"
],
"description": "Current state of instance patch."
},
"attemptCount": {
"description": "The number of times the agent that the agent attempts to apply the patch.",
"type": "string",
"format": "int64"
}
}
},
"SoftwareRecipeStep": {
"properties": {
"dpkgInstallation": {
"$ref": "SoftwareRecipeStepInstallDpkg",
"description": "Installs a deb file via dpkg."
},
"scriptRun": {
"description": "Runs commands in a shell.",
"$ref": "SoftwareRecipeStepRunScript"
},
"msiInstallation": {
"description": "Installs an MSI file.",
"$ref": "SoftwareRecipeStepInstallMsi"
},
"rpmInstallation": {
"description": "Installs an rpm file via the rpm utility.",
"$ref": "SoftwareRecipeStepInstallRpm"
},
"fileCopy": {
"description": "Copies a file onto the instance.",
"$ref": "SoftwareRecipeStepCopyFile"
},
"fileExec": {
"$ref": "SoftwareRecipeStepExecFile",
"description": "Executes an artifact or local file."
},
"archiveExtraction": {
"description": "Extracts an archive into the specified directory.",
"$ref": "SoftwareRecipeStepExtractArchive"
}
},
"id": "SoftwareRecipeStep",
"type": "object",
"description": "An action that can be taken as part of installing or updating a recipe."
},
"Assignment": {
"id": "Assignment",
"type": "object",
"properties": {
"osTypes": {
"type": "array",
"items": {
"$ref": "AssignmentOsType"
},
"description": "Targets VM instances matching at least one of the following OS types. VM instances must match all supplied criteria for a given OsType to be included."
},
"instanceNamePrefixes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Targets VM instances whose name starts with one of these prefixes. Like labels, this is another way to group VM instances when targeting configs, for example prefix=\"prod-\". Only supported for project-level policies."
},
"instances": {
"items": {
"type": "string"
},
"type": "array",
"description": "Targets any of the instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`. Instance targeting is uncommon and is supported to facilitate the management of changes by the instance or to target specific VM instances for development and testing. Only supported for project-level policies and must reference instances within this project."
},
"groupLabels": {
"description": "Targets instances matching at least one of these label sets. This allows an assignment to target disparate groups, for example \"env=prod or env=staging\".",
"type": "array",
"items": {
"$ref": "AssignmentGroupLabel"
}
},
"zones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Targets instances in any of these zones. Leave empty to target instances in any zone. Zonal targeting is uncommon and is supported to facilitate the management of changes by zone."
}
},
"description": "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."
},
"EffectiveGuestPolicy": {
"id": "EffectiveGuestPolicy",
"description": "The effective guest policy that applies to a VM instance.",
"properties": {
"packages": {
"type": "array",
"description": "List of package configurations assigned to the VM instance.",
"items": {
"$ref": "EffectiveGuestPolicySourcedPackage"
}
},
"packageRepositories": {
"type": "array",
"description": "List of package repository configurations assigned to the VM instance.",
"items": {
"$ref": "EffectiveGuestPolicySourcedPackageRepository"
}
},
"softwareRecipes": {
"description": "List of recipes assigned to the VM instance.",
"type": "array",
"items": {
"$ref": "EffectiveGuestPolicySourcedSoftwareRecipe"
}
}
},
"type": "object"
},
"PatchInstanceFilter": {
"properties": {
"groupLabels": {
"items": {
"$ref": "PatchInstanceFilterGroupLabel"
},
"type": "array",
"description": "Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example \"env=prod or env=staging\"."
},
"instances": {
"items": {
"type": "string"
},
"description": "Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`",
"type": "array"
},
"instanceNamePrefixes": {
"description": "Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix=\"prod-\".",
"type": "array",
"items": {
"type": "string"
}
},
"all": {
"type": "boolean",
"description": "Target all VM instances in the project. If true, no other criteria is permitted."
},
"zones": {
"items": {
"type": "string"
},
"description": "Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone.",
"type": "array"
}
},
"id": "PatchInstanceFilter",
"description": "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.",
"type": "object"
},
"TimeZone": {
"properties": {
"id": {
"type": "string",
"description": "IANA Time Zone Database time zone, e.g. \"America/New_York\"."
},
"version": {
"description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".",
"type": "string"
}
},
"type": "object",
"description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).",
"id": "TimeZone"
},
"WindowsUpdateSettings": {
"id": "WindowsUpdateSettings",
"description": "Windows patching is performed using the Windows Update Agent.",
"properties": {
"classifications": {
"type": "array",
"items": {
"enumDescriptions": [
"Invalid. If classifications are included, they must be specified.",
"\"A widely released fix for a specific problem that addresses a critical, non-security-related bug.\" [1]",
"\"A widely released fix for a product-specific, security-related vulnerability. Security vulnerabilities are rated by their severity. The severity rating is indicated in the Microsoft security bulletin as critical, important, moderate, or low.\" [1]",
"\"A widely released and frequent software update that contains additions to a product's definition database. Definition databases are often used to detect objects that have specific attributes, such as malicious code, phishing websites, or junk mail.\" [1]",
"\"Software that controls the input and output of a device.\" [1]",
"\"New product functionality that is first distributed outside the context of a product release and that is typically included in the next full product release.\" [1]",
"\"A tested, cumulative set of all hotfixes, security updates, critical updates, and updates. Additionally, service packs may contain additional fixes for problems that are found internally since the release of the product. Service packs my also contain a limited number of customer-requested design changes or features.\" [1]",
"\"A utility or feature that helps complete a task or set of tasks.\" [1]",
"\"A tested, cumulative set of hotfixes, security updates, critical updates, and updates that are packaged together for easy deployment. A rollup generally targets a specific area, such as security, or a component of a product, such as Internet Information Services (IIS).\" [1]",
"\"A widely released fix for a specific problem. An update addresses a noncritical, non-security-related bug.\" [1]"
],
"enum": [
"CLASSIFICATION_UNSPECIFIED",
"CRITICAL",
"SECURITY",
"DEFINITION",
"DRIVER",
"FEATURE_PACK",
"SERVICE_PACK",
"TOOL",
"UPDATE_ROLLUP",
"UPDATE"
],
"type": "string"
},
"description": "Only apply updates of these windows update classifications. If empty, all updates are applied."
},
"exclusivePatches": {
"items": {
"type": "string"
},
"type": "array",
"description": "An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations."
},
"excludes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of KBs to exclude from update."
}
},
"type": "object"
},
"ListPatchDeploymentsResponse": {
"id": "ListPatchDeploymentsResponse",
"properties": {
"patchDeployments": {
"description": "The list of patch deployments.",
"type": "array",
"items": {
"$ref": "PatchDeployment"
}
},
"nextPageToken": {
"type": "string",
"description": "A pagination token that can be used to get the next page of patch deployments."
}
},
"description": "A response message for listing patch deployments.",
"type": "object"
},
"EffectiveGuestPolicySourcedPackage": {
"properties": {
"package": {
"description": "A software package to configure on the VM instance.",
"$ref": "Package"
},
"source": {
"type": "string",
"description": "Name of the guest policy providing this config."
}
},
"type": "object",
"description": "A guest policy package including its source.",
"id": "EffectiveGuestPolicySourcedPackage"
},
"SoftwareRecipeStepCopyFile": {
"id": "SoftwareRecipeStepCopyFile",
"description": "Copies the artifact to the specified path on the instance.",
"properties": {
"destination": {
"description": "Required. The absolute path on the instance to put the file.",
"type": "string"
},
"permissions": {
"type": "string",
"description": "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"
},
"overwrite": {
"type": "boolean",
"description": "Whether to allow this step to overwrite existing files. If this is false and the file already exists the file is not overwritten and the step is considered a success. Defaults to false."
},
"artifactId": {
"type": "string",
"description": "Required. The id of the relevant artifact in the recipe."
}
},
"type": "object"
},
"Inventory": {
"description": "The inventory details of a VM.",
"id": "Inventory",
"properties": {
"items": {
"type": "object",
"description": "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.",
"additionalProperties": {
"$ref": "InventoryItem"
}
},
"osInfo": {
"description": "Base level operating system information for the VM.",
"$ref": "InventoryOsInfo"
}
},
"type": "object"
},
"SoftwareRecipeStepInstallRpm": {
"type": "object",
"description": "Installs an rpm file via the rpm utility.",
"id": "SoftwareRecipeStepInstallRpm",
"properties": {
"artifactId": {
"description": "Required. The id of the relevant artifact in the recipe.",
"type": "string"
}
}
},
"AptRepository": {
"type": "object",
"id": "AptRepository",
"properties": {
"archiveType": {
"enum": [
"ARCHIVE_TYPE_UNSPECIFIED",
"DEB",
"DEB_SRC"
],
"type": "string",
"description": "Type of archive files in this repository. The default behavior is DEB.",
"enumDescriptions": [
"Unspecified.",
"DEB indicates that the archive contains binary files.",
"DEB_SRC indicates that the archive contains source files."
]
},
"gpgKey": {
"type": "string",
"description": "URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg` containing all the keys in any applied guest policy."
},
"uri": {
"type": "string",
"description": "Required. URI for this repository."
},
"components": {
"items": {
"type": "string"
},
"type": "array",
"description": "Required. List of components for this repository. Must contain at least one item."
},
"distribution": {
"type": "string",
"description": "Required. Distribution of this repository."
}
},
"description": "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`."
},
"ZypperRepository": {
"properties": {
"displayName": {
"description": "The display name of the repository.",
"type": "string"
},
"gpgKeys": {
"description": "URIs of GPG keys.",
"items": {
"type": "string"
},
"type": "array"
},
"baseUrl": {
"description": "Required. The location of the repository directory.",
"type": "string"
},
"id": {
"description": "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 guest policy conflicts.",
"type": "string"
}
},
"id": "ZypperRepository",
"type": "object",
"description": "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`."
},
"GooSettings": {
"properties": {},
"type": "object",
"id": "GooSettings",
"description": "Googet patching is performed by running `googet update`."
},
"PatchJob": {
"type": "object",
"properties": {
"updateTime": {
"description": "Last time this patch job was updated.",
"format": "google-datetime",
"type": "string"
},
"patchConfig": {
"description": "Patch configuration being applied.",
"$ref": "PatchConfig"
},
"instanceDetailsSummary": {
"description": "Summary of instance details.",
"$ref": "PatchJobInstanceDetailsSummary"
},
"dryRun": {
"type": "boolean",
"description": "If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance."
},
"createTime": {
"description": "Time this patch job was created.",
"type": "string",
"format": "google-datetime"
},
"patchDeployment": {
"description": "Output only. Name of the patch deployment that created this patch job.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "The current state of the PatchJob.",
"enumDescriptions": [
"State must be specified.",
"The patch job was successfully initiated.",
"The patch job is looking up instances to run the patch on.",
"Instances are being patched.",
"Patch job completed successfully.",
"Patch job completed but there were errors.",
"The patch job was canceled.",
"The patch job timed out."
],
"enum": [
"STATE_UNSPECIFIED",
"STARTED",
"INSTANCE_LOOKUP",
"PATCHING",
"SUCCEEDED",
"COMPLETED_WITH_ERRORS",
"CANCELED",
"TIMED_OUT"
],
"type": "string"
},
"duration": {
"type": "string",
"format": "google-duration",
"description": "Duration of the patch job. After the duration ends, the patch job times out."
},
"instanceFilter": {
"description": "Instances to patch.",
"$ref": "PatchInstanceFilter"
},
"description": {
"type": "string",
"description": "Description of the patch job. Length of the description is limited to 1024 characters."
},
"rollout": {
"description": "Rollout strategy being applied.",
"$ref": "PatchRollout"
},
"errorMessage": {
"type": "string",
"description": "If this patch job failed, this message provides information about the failure."
},
"percentComplete": {
"description": "Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.",
"type": "number",
"format": "double"
},
"name": {
"type": "string",
"description": "Unique identifier for this patch job in the form `projects/*/patchJobs/*`"
},
"displayName": {
"type": "string",
"description": "Display name for this patch job. This is not a unique identifier."
}
},
"description": "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).",
"id": "PatchJob"
},
"RecurringSchedule": {
"type": "object",
"id": "RecurringSchedule",
"properties": {
"endTime": {
"format": "google-datetime",
"type": "string",
"description": "Optional. The end time at which a recurring patch deployment schedule is no longer active."
},
"startTime": {
"format": "google-datetime",
"description": "Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment.",
"type": "string"
},
"weekly": {
"$ref": "WeeklySchedule",
"description": "Required. Schedule with weekly executions."
},
"lastExecuteTime": {
"type": "string",
"description": "Output only. The time the last patch job ran successfully.",
"readOnly": true,
"format": "google-datetime"
},
"timeZone": {
"description": "Required. Defines the time zone that `time_of_day` is relative to. The rules for daylight saving time are determined by the chosen time zone.",
"$ref": "TimeZone"
},
"monthly": {
"description": "Required. Schedule with monthly executions.",
"$ref": "MonthlySchedule"
},
"timeOfDay": {
"$ref": "TimeOfDay",
"description": "Required. Time of the day to run a recurring deployment."
},
"nextExecuteTime": {
"type": "string",
"format": "google-datetime",
"readOnly": true,
"description": "Output only. The time the next patch job is scheduled to run."
},
"frequency": {
"description": "Required. The frequency unit of this recurring schedule.",
"enum": [
"FREQUENCY_UNSPECIFIED",
"WEEKLY",
"MONTHLY"
],
"type": "string",
"enumDescriptions": [
"Invalid. A frequency must be specified.",
"Indicates that the frequency should be expressed in terms of weeks.",
"Indicates that the frequency should be expressed in terms of months."
]
}
},
"description": "Sets the time for recurring patch deployments."
},
"OneTimeSchedule": {
"type": "object",
"properties": {
"executeTime": {
"type": "string",
"format": "google-datetime",
"description": "Required. The desired patch job execution time."
}
},
"description": "Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"id": "OneTimeSchedule"
},
"SoftwareRecipeStepInstallMsi": {
"description": "Installs an MSI file.",
"properties": {
"flags": {
"description": "The flags to use when installing the MSI defaults to [\"/i\"] (i.e. the install flag).",
"items": {
"type": "string"
},
"type": "array"
},
"allowedExitCodes": {
"description": "Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0]",
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"artifactId": {
"type": "string",
"description": "Required. The id of the relevant artifact in the recipe."
}
},
"type": "object",
"id": "SoftwareRecipeStepInstallMsi"
},
"YumSettings": {
"id": "YumSettings",
"properties": {
"minimal": {
"description": "Will cause patch to run `yum update-minimal` instead.",
"type": "boolean"
},
"security": {
"type": "boolean",
"description": "Adds the `--security` flag to `yum update`. Not supported on all platforms."
},
"excludes": {
"description": "List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.",
"items": {
"type": "string"
},
"type": "array"
},
"exclusivePackages": {
"items": {
"type": "string"
},
"description": "An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields.",
"type": "array"
}
},
"description": "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.",
"type": "object"
},
"ListPatchJobInstanceDetailsResponse": {
"description": "A response message for listing the instances details for a patch job.",
"type": "object",
"properties": {
"nextPageToken": {
"type": "string",
"description": "A pagination token that can be used to get the next page of results."
},
"patchJobInstanceDetails": {
"items": {
"$ref": "PatchJobInstanceDetails"
},
"description": "A list of instance status.",
"type": "array"
}
},
"id": "ListPatchJobInstanceDetailsResponse"
},
"SoftwareRecipeStepExecFile": {
"properties": {
"artifactId": {
"description": "The id of the relevant artifact in the recipe.",
"type": "string"
},
"allowedExitCodes": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
},
"description": "Defaults to [0]. A list of possible return values that the program can return to indicate a success."
},
"localPath": {
"type": "string",
"description": "The absolute path of the file on the local filesystem."
},
"args": {
"type": "array",
"description": "Arguments to be passed to the provided executable.",
"items": {
"type": "string"
}
}
},
"description": "Executes an artifact or local file.",
"type": "object",
"id": "SoftwareRecipeStepExecFile"
},
"AptSettings": {
"properties": {
"exclusivePackages": {
"type": "array",
"items": {
"type": "string"
},
"description": "An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields."
},
"type": {
"type": "string",
"description": "By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.",
"enum": [
"TYPE_UNSPECIFIED",
"DIST",
"UPGRADE"
],
"enumDescriptions": [
"By default, upgrade will be performed.",
"Runs `apt-get dist-upgrade`.",
"Runs `apt-get upgrade`."
]
},
"excludes": {
"description": "List of packages to exclude from update. These packages will be excluded",
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed.",
"type": "object",
"id": "AptSettings"
},
"TimeOfDay": {
"type": "object",
"description": "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`.",
"id": "TimeOfDay",
"properties": {
"seconds": {
"type": "integer",
"format": "int32",
"description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds."
},
"nanos": {
"description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
"type": "integer",
"format": "int32"
},
"minutes": {
"type": "integer",
"description": "Minutes of hour of day. Must be from 0 to 59.",
"format": "int32"
},
"hours": {
"type": "integer",
"description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.",
"format": "int32"
}
}
},
"PatchRollout": {
"id": "PatchRollout",
"description": "Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs.",
"properties": {
"disruptionBudget": {
"description": "The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.",
"$ref": "FixedOrPercent"
},
"mode": {
"enum": [
"MODE_UNSPECIFIED",
"ZONE_BY_ZONE",
"CONCURRENT_ZONES"
],
"type": "string",
"description": "Mode of the patch rollout.",
"enumDescriptions": [
"Mode must be specified.",
"Patches are applied one zone at a time. The patch job begins in the region with the lowest number of targeted VMs. Within the region, patching begins in the zone with the lowest number of targeted VMs. If multiple regions (or zones within a region) have the same number of targeted VMs, a tie-breaker is achieved by sorting the regions or zones in alphabetical order.",
"Patches are applied to VMs in all zones at the same time."
]
}
},
"type": "object"
},
"SoftwareRecipeArtifact": {
"description": "Specifies a resource to be used in the recipe.",
"properties": {
"gcs": {
"description": "A Google Cloud Storage artifact.",
"$ref": "SoftwareRecipeArtifactGcs"
},
"id": {
"description": "Required. Id of the artifact, which the installation and update steps of this recipe can reference. Artifacts in a recipe cannot have the same id.",
"type": "string"
},
"remote": {
"description": "A generic remote artifact.",
"$ref": "SoftwareRecipeArtifactRemote"
},
"allowInsecure": {
"type": "boolean",
"description": "Defaults to false. When false, recipes are subject to validations based on the artifact type: Remote: A checksum must be specified, and only protocols with transport-layer security are permitted. GCS: An object generation number must be specified."
}
},
"type": "object",
"id": "SoftwareRecipeArtifact"
},
"InventoryWindowsUpdatePackage": {
"id": "InventoryWindowsUpdatePackage",
"properties": {
"lastDeploymentChangeTime": {
"type": "string",
"format": "google-datetime",
"description": "The last published date of the update, in (UTC) date and time."
},
"categories": {
"description": "The categories that are associated with this update package.",
"type": "array",
"items": {
"$ref": "InventoryWindowsUpdatePackageWindowsUpdateCategory"
}
},
"supportUrl": {
"description": "A hyperlink to the language-specific support information for the update.",
"type": "string"
},
"revisionNumber": {
"description": "The revision number of this update package.",
"type": "integer",
"format": "int32"
},
"moreInfoUrls": {
"description": "A collection of URLs that provide more information about the update package.",
"items": {
"type": "string"
},
"type": "array"
},
"title": {
"description": "The localized title of the update package.",
"type": "string"
},
"description": {
"type": "string",
"description": "The localized description of the update package."
},
"kbArticleIds": {
"description": "A collection of Microsoft Knowledge Base article IDs that are associated with the update package.",
"items": {
"type": "string"
},
"type": "array"
},
"updateId": {
"type": "string",
"description": "Gets the identifier of an update package. Stays the same across revisions."
}
},
"description": "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.",
"type": "object"
},
"InventoryItem": {
"description": "A single piece of inventory on a VM.",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The specific type of inventory, correlating to its specific details.",
"enum": [
"TYPE_UNSPECIFIED",
"INSTALLED_PACKAGE",
"AVAILABLE_PACKAGE"
],
"enumDescriptions": [
"Invalid. An type must be specified.",
"This represents a package that is installed on the VM.",
"This represents an update that is available for a package."
]
},
"id": {
"description": "Identifier for this item, unique across items for this VM.",
"type": "string"
},
"createTime": {
"description": "When this inventory item was first detected.",
"format": "google-datetime",
"type": "string"
},
"installedPackage": {
"$ref": "InventorySoftwarePackage",
"description": "Software package present on the VM instance."
},
"updateTime": {
"type": "string",
"description": "When this inventory item was last modified.",
"format": "google-datetime"
},
"availablePackage": {
"$ref": "InventorySoftwarePackage",
"description": "Software package available to be installed on the VM instance."
},
"originType": {
"enumDescriptions": [
"Invalid. An origin type must be specified.",
"This inventory item was discovered as the result of the agent reporting inventory via the reporting API."
],
"description": "The origin of this inventory item.",
"type": "string",
"enum": [
"ORIGIN_TYPE_UNSPECIFIED",
"INVENTORY_REPORT"
]
}
},
"id": "InventoryItem"
},
"ExecStepConfig": {
"id": "ExecStepConfig",
"properties": {
"localPath": {
"description": "An absolute path to the executable on the VM.",
"type": "string"
},
"interpreter": {
"description": "The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\\(Unix\\)).",
"enumDescriptions": [
"Invalid for a Windows ExecStepConfig. For a Linux ExecStepConfig, the interpreter will be parsed from the shebang line of the script if unspecified.",
"Indicates that the script is run with `/bin/sh` on Linux and `cmd` on Windows.",
"Indicates that the file is run with PowerShell flags `-NonInteractive`, `-NoProfile`, and `-ExecutionPolicy Bypass`."
],
"type": "string",
"enum": [
"INTERPRETER_UNSPECIFIED",
"SHELL",
"POWERSHELL"
]
},
"gcsObject": {
"$ref": "GcsObject",
"description": "A Google Cloud Storage object containing the executable."
},
"allowedSuccessCodes": {
"description": "Defaults to [0]. A list of possible return values that the execution can return to indicate a success.",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
},
"type": "object",
"description": "Common configurations for an ExecStep."
},
"LookupEffectiveGuestPolicyRequest": {
"id": "LookupEffectiveGuestPolicyRequest",
"type": "object",
"description": "A request message for getting the effective guest policy assigned to the instance.",
"properties": {
"osVersion": {
"description": "Version of the OS running on the instance. The OS Config agent only provides this field for targeting if OS Inventory is enabled for that VM instance.",
"type": "string"
},
"osShortName": {
"description": "Short name of the OS running on the instance. The OS Config agent only provides this field for targeting if OS Inventory is enabled for that instance.",
"type": "string"
},
"osArchitecture": {
"type": "string",
"description": "Architecture of OS running on the instance. The OS Config agent only provides this field for targeting if OS Inventory is enabled for that instance."
}
}
},
"WeeklySchedule": {
"id": "WeeklySchedule",
"properties": {
"dayOfWeek": {
"enumDescriptions": [
"The day of the week is unspecified.",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"type": "string",
"enum": [
"DAY_OF_WEEK_UNSPECIFIED",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"description": "Required. Day of the week."
}
},
"description": "Represents a weekly schedule.",
"type": "object"
},
"PatchDeployment": {
"properties": {
"description": {
"type": "string",
"description": "Optional. Description of the patch deployment. Length of the description is limited to 1024 characters."
},
"updateTime": {
"type": "string",
"readOnly": true,
"description": "Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"format": "google-datetime"
},
"instanceFilter": {
"description": "Required. VM instances to patch.",
"$ref": "PatchInstanceFilter"
},
"createTime": {
"format": "google-datetime",
"type": "string",
"readOnly": true,
"description": "Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format."
},
"rollout": {
"$ref": "PatchRollout",
"description": "Optional. Rollout strategy of the patch job."
},
"duration": {
"type": "string",
"format": "google-duration",
"description": "Optional. Duration of the patch. After the duration ends, the patch times out."
},
"patchConfig": {
"$ref": "PatchConfig",
"description": "Optional. Patch configuration that is applied."
},
"name": {
"type": "string",
"description": "Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment."
},
"lastExecuteTime": {
"type": "string",
"description": "Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"readOnly": true,
"format": "google-datetime"
},
"oneTimeSchedule": {
"description": "Required. Schedule a one-time execution.",
"$ref": "OneTimeSchedule"
},
"recurringSchedule": {
"description": "Required. Schedule recurring executions.",
"$ref": "RecurringSchedule"
}
},
"type": "object",
"description": "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).",
"id": "PatchDeployment"
},
"MonthlySchedule": {
"description": "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\".",
"properties": {
"monthDay": {
"type": "integer",
"format": "int32",
"description": "Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run \"every month on the 31st\" will not run in February, April, June, etc."
},
"weekDayOfMonth": {
"description": "Required. Week day in a month.",
"$ref": "WeekDayOfMonth"
}
},
"id": "MonthlySchedule",
"type": "object"
},
"AssignmentGroupLabel": {
"description": "Represents a group of VM intances that can be identified as having all these labels, for example \"env=prod and app=web\".",
"id": "AssignmentGroupLabel",
"type": "object",
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"description": "Google Compute Engine instance labels that must be present for an instance to be included in this assignment group."
}
}
},
"SoftwareRecipeStepRunScript": {
"properties": {
"allowedExitCodes": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0]"
},
"script": {
"description": "Required. The shell script to be executed.",
"type": "string"
},
"interpreter": {
"enumDescriptions": [
"Default value for ScriptType.",
"Indicates that the script is run with `/bin/sh` on Linux and `cmd` on windows.",
"Indicates that the script is run with powershell."
],
"type": "string",
"enum": [
"INTERPRETER_UNSPECIFIED",
"SHELL",
"POWERSHELL"
],
"description": "The script interpreter to use to run the script. If no interpreter is specified the script is executed directly, which likely only succeed for scripts with [shebang lines](https://en.wikipedia.org/wiki/Shebang_\\(Unix\\))."
}
},
"id": "SoftwareRecipeStepRunScript",
"type": "object",
"description": "Runs a script through an interpreter."
},
"Empty": {
"type": "object",
"properties": {},
"description": "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); } The JSON representation for `Empty` is empty JSON object `{}`.",
"id": "Empty"
},
"PatchJobInstanceDetailsSummary": {
"properties": {
"notifiedInstanceCount": {
"format": "int64",
"description": "Number of instances notified about patch job.",
"type": "string"
},
"inactiveInstanceCount": {
"description": "Number of instances that are inactive.",
"type": "string",
"format": "int64"
},
"succeededRebootRequiredInstanceCount": {
"format": "int64",
"description": "Number of instances that require reboot.",
"type": "string"
},
"prePatchStepInstanceCount": {
"description": "Number of instances that are running the pre-patch step.",
"type": "string",
"format": "int64"
},
"postPatchStepInstanceCount": {
"type": "string",
"format": "int64",
"description": "Number of instances that are running the post-patch step."
},
"timedOutInstanceCount": {
"description": "Number of instances that exceeded the time out while applying the patch.",
"format": "int64",
"type": "string"
},
"pendingInstanceCount": {
"description": "Number of instances pending patch job.",
"format": "int64",
"type": "string"
},
"startedInstanceCount": {
"type": "string",
"format": "int64",
"description": "Number of instances that have started."
},
"succeededInstanceCount": {
"description": "Number of instances that have completed successfully.",
"format": "int64",
"type": "string"
},
"applyingPatchesInstanceCount": {
"format": "int64",
"type": "string",
"description": "Number of instances that are applying patches."
},
"downloadingPatchesInstanceCount": {
"description": "Number of instances that are downloading patches.",
"format": "int64",
"type": "string"
},
"ackedInstanceCount": {
"description": "Number of instances that have acked and will start shortly.",
"type": "string",
"format": "int64"
},
"rebootingInstanceCount": {
"format": "int64",
"type": "string",
"description": "Number of instances rebooting."
},
"failedInstanceCount": {
"type": "string",
"description": "Number of instances that failed.",
"format": "int64"
},
"noAgentDetectedInstanceCount": {
"type": "string",
"format": "int64",
"description": "Number of instances that do not appear to be running the agent. Check to ensure that the agent is installed, running, and able to communicate with the service."
}
},
"description": "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.",
"type": "object",
"id": "PatchJobInstanceDetailsSummary"
},
"PatchInstanceFilterGroupLabel": {
"properties": {
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Compute Engine instance labels that must be present for a VM instance to be targeted by this filter."
}
},
"type": "object",
"id": "PatchInstanceFilterGroupLabel",
"description": "Represents a group of VMs that can be identified as having all these labels, for example \"env=prod and app=web\"."
},
"SoftwareRecipeArtifactRemote": {
"id": "SoftwareRecipeArtifactRemote",
"description": "Specifies an artifact available via some URI.",
"properties": {
"uri": {
"description": "URI from which to fetch the object. It should contain both the protocol and path following the format {protocol}://{location}.",
"type": "string"
},
"checksum": {
"type": "string",
"description": "Must be provided if `allow_insecure` is `false`. SHA256 checksum in hex format, to compare to the checksum of the artifact. If the checksum is not empty and it doesn't match the artifact then the recipe installation fails before running any of the steps."
}
},
"type": "object"
},
"ListPatchJobsResponse": {
"id": "ListPatchJobsResponse",
"type": "object",
"properties": {
"patchJobs": {
"description": "The list of patch jobs.",
"type": "array",
"items": {
"$ref": "PatchJob"
}
},
"nextPageToken": {
"type": "string",
"description": "A pagination token that can be used to get the next page of results."
}
},
"description": "A response message for listing patch jobs."
},
"SoftwareRecipeArtifactGcs": {
"description": "Specifies an artifact available as a Google Cloud Storage object.",
"type": "object",
"properties": {
"bucket": {
"type": "string",
"description": "Bucket of the Google Cloud Storage object. Given an example URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `my-bucket`."
},
"object": {
"description": "Name of the Google Cloud Storage object. As specified [here] (https://cloud.google.com/storage/docs/naming#objectnames) Given an example URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `foo/bar`.",
"type": "string"
},
"generation": {
"format": "int64",
"description": "Must be provided if allow_insecure is false. Generation number of the Google Cloud Storage object. `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `1234567`.",
"type": "string"
}
},
"id": "SoftwareRecipeArtifactGcs"
},
"WeekDayOfMonth": {
"description": "Represents one week day in a month. An example is \"the 4th Sunday\".",
"type": "object",
"id": "WeekDayOfMonth",
"properties": {
"weekOrdinal": {
"type": "integer",
"format": "int32",
"description": "Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month."
},
"dayOfWeek": {
"enumDescriptions": [
"The day of the week is unspecified.",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"type": "string",
"description": "Required. A day of the week.",
"enum": [
"DAY_OF_WEEK_UNSPECIFIED",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
]
}
}
},
"GuestPolicy": {
"properties": {
"description": {
"type": "string",
"description": "Description of the guest policy. Length of the description is limited to 1024 characters."
},
"createTime": {
"format": "google-datetime",
"type": "string",
"description": "Output only. Time this guest policy was created.",
"readOnly": true
},
"packageRepositories": {
"description": "A list of package repositories to configure on the VM instance. This is done before any other configs are applied so they can use these repos. Package repositories are only configured if the corresponding package manager(s) are available.",
"type": "array",
"items": {
"$ref": "PackageRepository"
}
},
"assignment": {
"description": "Required. Specifies the VM instances that are assigned to this policy. This allows you to target sets or groups of VM instances by different parameters such as labels, names, OS, or zones. If left empty, all VM instances underneath this policy are targeted. At the same level in the resource hierarchy (that is within a project), the service prevents the creation of multiple policies that conflict with each other. For more information, see how the service [handles assignment conflicts](/compute/docs/os-config-management/create-guest-policy#handle-conflicts).",
"$ref": "Assignment"
},
"updateTime": {
"type": "string",
"readOnly": true,
"description": "Output only. Last time this guest policy was updated.",
"format": "google-datetime"
},
"packages": {
"type": "array",
"items": {
"$ref": "Package"
},
"description": "The software packages to be managed by this policy."
},
"name": {
"description": "Required. Unique name of the resource in this project using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`.",
"type": "string"
},
"etag": {
"description": "The etag for this guest policy. If this is provided on update, it must match the server's etag.",
"type": "string"
},
"recipes": {
"type": "array",
"items": {
"$ref": "SoftwareRecipe"
},
"description": "A list of Recipes to install on the VM instance."
}
},
"id": "GuestPolicy",
"type": "object",
"description": "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."
},
"ZypperSettings": {
"id": "ZypperSettings",
"description": "Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual.",
"type": "object",
"properties": {
"exclusivePatches": {
"type": "array",
"items": {
"type": "string"
},
"description": "An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields."
},
"categories": {
"items": {
"type": "string"
},
"description": "Install only patches with these categories. Common categories include security, recommended, and feature.",
"type": "array"
},
"withOptional": {
"description": "Adds the `--with-optional` flag to `zypper patch`.",
"type": "boolean"
},
"excludes": {
"items": {
"type": "string"
},
"description": "List of patches to exclude from update.",
"type": "array"
},
"withUpdate": {
"description": "Adds the `--with-update` flag, to `zypper patch`.",
"type": "boolean"
},
"severities": {
"type": "array",
"items": {
"type": "string"
},
"description": "Install only patches with these severities. Common severities include critical, important, moderate, and low."
}
}
},
"InventoryWindowsQuickFixEngineeringPackage": {
"description": "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",
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "A textual description of the QFE update."
},
"hotFixId": {
"description": "Unique identifier associated with a particular QFE update.",
"type": "string"
},
"caption": {
"type": "string",
"description": "A short textual description of the QFE update."
},
"installTime": {
"type": "string",
"description": "Date that the QFE update was installed. Mapped from installed_on field.",
"format": "google-datetime"
}
},
"id": "InventoryWindowsQuickFixEngineeringPackage"
},
"ListGuestPoliciesResponse": {
"description": "A response message for listing guest policies.",
"properties": {
"guestPolicies": {
"items": {
"$ref": "GuestPolicy"
},
"description": "The list of GuestPolicies.",
"type": "array"
},
"nextPageToken": {
"description": "A pagination token that can be used to get the next page of guest policies.",
"type": "string"
}
},
"id": "ListGuestPoliciesResponse",
"type": "object"
},
"ExecStep": {
"description": "A step that runs an executable for a PatchJob.",
"id": "ExecStep",
"type": "object",
"properties": {
"windowsExecStepConfig": {
"description": "The ExecStepConfig for all Windows VMs targeted by the PatchJob.",
"$ref": "ExecStepConfig"
},
"linuxExecStepConfig": {
"$ref": "ExecStepConfig",
"description": "The ExecStepConfig for all Linux VMs targeted by the PatchJob."
}
}
},
"SoftwareRecipeStepExtractArchive": {
"id": "SoftwareRecipeStepExtractArchive",
"description": "Extracts an archive of the type specified in the specified directory.",
"properties": {
"destination": {
"description": "Directory to extract archive to. Defaults to `/` on Linux or `C:\\` on Windows.",
"type": "string"
},
"artifactId": {
"type": "string",
"description": "Required. The id of the relevant artifact in the recipe."
},
"type": {
"enumDescriptions": [
"Indicates that the archive type isn't specified.",
"Indicates that the archive is a tar archive with no encryption.",
"Indicates that the archive is a tar archive with gzip encryption.",
"Indicates that the archive is a tar archive with bzip encryption.",
"Indicates that the archive is a tar archive with lzma encryption.",
"Indicates that the archive is a tar archive with xz encryption.",
"Indicates that the archive is a zip archive."
],
"type": "string",
"enum": [
"ARCHIVE_TYPE_UNSPECIFIED",
"TAR",
"TAR_GZIP",
"TAR_BZIP",
"TAR_LZMA",
"TAR_XZ",
"ZIP"
],
"description": "Required. The type of the archive to extract."
}
},
"type": "object"
},
"YumRepository": {
"id": "YumRepository",
"description": "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`.",
"type": "object",
"properties": {
"baseUrl": {
"type": "string",
"description": "Required. The location of the repository directory."
},
"gpgKeys": {
"type": "array",
"items": {
"type": "string"
},
"description": "URIs of GPG keys."
},
"displayName": {
"description": "The display name of the repository.",
"type": "string"
},
"id": {
"type": "string",
"description": "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 guest policy conflicts."
}
}
},
"InventoryVersionedPackage": {
"description": "Information related to the a standard versioned package. This includes package info for APT, Yum, Zypper, and Googet package managers.",
"id": "InventoryVersionedPackage",
"type": "object",
"properties": {
"packageName": {
"type": "string",
"description": "The name of the package."
},
"architecture": {
"type": "string",
"description": "The system architecture this package is intended for."
},
"version": {
"description": "The version of the package.",
"type": "string"
}
}
},
"InventoryWindowsUpdatePackageWindowsUpdateCategory": {
"description": "Categories specified by the Windows Update.",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The identifier of the windows update category."
},
"name": {
"description": "The name of the windows update category.",
"type": "string"
}
},
"id": "InventoryWindowsUpdatePackageWindowsUpdateCategory"
},
"Package": {
"description": "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`",
"properties": {
"desiredState": {
"description": "The desired_state the agent should maintain for this package. The default is to ensure the package is installed.",
"type": "string",
"enumDescriptions": [
"The default is to ensure the package is installed.",
"The agent ensures that the package is installed.",
"The agent ensures that the package is installed and periodically checks for and install any updates.",
"The agent ensures that the package is not installed and uninstall it if detected."
],
"enum": [
"DESIRED_STATE_UNSPECIFIED",
"INSTALLED",
"UPDATED",
"REMOVED"
]
},
"name": {
"description": "Required. The name of the package. A package is uniquely identified for conflict validation by checking the package name and the manager(s) that the package targets.",
"type": "string"
},
"manager": {
"enum": [
"MANAGER_UNSPECIFIED",
"ANY",
"APT",
"YUM",
"ZYPPER",
"GOO"
],
"type": "string",
"description": "Type of package manager that can be used to install this package. If a system does not have the package manager, the package is not installed or removed no error message is returned. By default, or if you specify `ANY`, the agent attempts to install and remove this package using the default package manager. This is useful when creating a policy that applies to different types of systems. The default behavior is ANY.",
"enumDescriptions": [
"The default behavior is ANY.",
"Apply this package config using the default system package manager.",
"Apply this package config only if Apt is available on the system.",
"Apply this package config only if Yum is available on the system.",
"Apply this package config only if Zypper is available on the system.",
"Apply this package config only if GooGet is available on the system."
]
}
},
"type": "object",
"id": "Package"
},
"GcsObject": {
"id": "GcsObject",
"description": "Google Cloud Storage object representation.",
"type": "object",
"properties": {
"generationNumber": {
"type": "string",
"description": "Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.",
"format": "int64"
},
"bucket": {
"description": "Required. Bucket of the Google Cloud Storage object.",
"type": "string"
},
"object": {
"type": "string",
"description": "Required. Name of the Google Cloud Storage object."
}
}
},
"InventorySoftwarePackage": {
"type": "object",
"properties": {
"zypperPatch": {
"description": "Details of a Zypper patch. For details about the Zypper package manager, see https://en.opensuse.org/SDB:Zypper_manual.",
"$ref": "InventoryZypperPatch"
},
"qfePackage": {
"$ref": "InventoryWindowsQuickFixEngineeringPackage",
"description": "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."
},
"cosPackage": {
"$ref": "InventoryVersionedPackage",
"description": "Details of a COS package."
},
"zypperPackage": {
"$ref": "InventoryVersionedPackage",
"description": "Details of a Zypper package. For details about the Zypper package manager, see https://en.opensuse.org/SDB:Zypper_manual."
},
"aptPackage": {
"$ref": "InventoryVersionedPackage",
"description": "Details of an APT package. For details about the apt package manager, see https://wiki.debian.org/Apt."
},
"googetPackage": {
"$ref": "InventoryVersionedPackage",
"description": "Details of a Googet package. For details about the googet package manager, see https://github.com/google/googet."
},
"yumPackage": {
"$ref": "InventoryVersionedPackage",
"description": "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."
},
"wuaPackage": {
"description": "Details of a Windows Update package. See https://docs.microsoft.com/en-us/windows/win32/api/_wua/ for information about Windows Update.",
"$ref": "InventoryWindowsUpdatePackage"
}
},
"description": "Software package information of the operating system.",
"id": "InventorySoftwarePackage"
},
"SoftwareRecipeStepInstallDpkg": {
"description": "Installs a deb via dpkg.",
"id": "SoftwareRecipeStepInstallDpkg",
"properties": {
"artifactId": {
"type": "string",
"description": "Required. The id of the relevant artifact in the recipe."
}
},
"type": "object"
},
"SoftwareRecipe": {
"description": "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.",
"id": "SoftwareRecipe",
"properties": {
"desiredState": {
"enumDescriptions": [
"The default is to ensure the package is installed.",
"The agent ensures that the package is installed.",
"The agent ensures that the package is installed and periodically checks for and install any updates.",
"The agent ensures that the package is not installed and uninstall it if detected."
],
"type": "string",
"description": "Default is INSTALLED. The desired state the agent should maintain for this recipe. INSTALLED: The software recipe is installed on the instance but won't be updated to new versions. UPDATED: The software recipe is installed on the instance. The recipe is updated to a higher version, if a higher version of the recipe is assigned to this instance. REMOVE: Remove is unsupported for software recipes and attempts to create or update a recipe to the REMOVE state is rejected.",
"enum": [
"DESIRED_STATE_UNSPECIFIED",
"INSTALLED",
"UPDATED",
"REMOVED"
]
},
"installSteps": {
"items": {
"$ref": "SoftwareRecipeStep"
},
"type": "array",
"description": "Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back."
},
"name": {
"type": "string",
"description": "Required. Unique identifier for the recipe. Only one recipe with a given name is installed on an instance. Names are also used to identify resources which helps to determine whether guest policies have conflicts. This means that requests to create multiple recipes with the same name and version are rejected since they could potentially have conflicting assignments."
},
"version": {
"type": "string",
"description": "The version of this software recipe. Version can be up to 4 period separated numbers (e.g. 12.34.56.78)."
},
"artifacts": {
"items": {
"$ref": "SoftwareRecipeArtifact"
},
"description": "Resources available to be used in the steps in the recipe.",
"type": "array"
},
"updateSteps": {
"description": "Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.",
"type": "array",
"items": {
"$ref": "SoftwareRecipeStep"
}
}
},
"type": "object"
},
"InventoryOsInfo": {
"id": "InventoryOsInfo",
"description": "Operating system information for the VM.",
"type": "object",
"properties": {
"shortName": {
"description": "The operating system short name. For example, 'windows' or 'debian'.",
"type": "string"
},
"osconfigAgentVersion": {
"description": "The current version of the OS Config agent running on the VM.",
"type": "string"
},
"architecture": {
"type": "string",
"description": "The system architecture of the operating system."
},
"kernelRelease": {
"description": "The kernel release of the operating system.",
"type": "string"
},
"longName": {
"description": "The operating system long name. For example 'Debian GNU/Linux 9' or 'Microsoft Window Server 2019 Datacenter'.",
"type": "string"
},
"hostname": {
"description": "The VM hostname.",
"type": "string"
},
"kernelVersion": {
"description": "The kernel version of the operating system.",
"type": "string"
},
"version": {
"type": "string",
"description": "The version of the operating system."
}
}
},
"CancelPatchJobRequest": {
"type": "object",
"properties": {},
"id": "CancelPatchJobRequest",
"description": "Message for canceling a patch job."
},
"EffectiveGuestPolicySourcedSoftwareRecipe": {
"properties": {
"source": {
"type": "string",
"description": "Name of the guest policy providing this config."
},
"softwareRecipe": {
"$ref": "SoftwareRecipe",
"description": "A software recipe to configure on the VM instance."
}
},
"id": "EffectiveGuestPolicySourcedSoftwareRecipe",
"description": "A guest policy recipe including its source.",
"type": "object"
},
"InventoryZypperPatch": {
"id": "InventoryZypperPatch",
"properties": {
"category": {
"type": "string",
"description": "The category of the patch."
},
"patchName": {
"type": "string",
"description": "The name of the patch."
},
"severity": {
"description": "The severity specified for this patch",
"type": "string"
},
"summary": {
"description": "Any summary information provided about this patch.",
"type": "string"
}
},
"description": "Details related to a Zypper Patch.",
"type": "object"
},
"ExecutePatchJobRequest": {
"id": "ExecutePatchJobRequest",
"properties": {
"description": {
"description": "Description of the patch job. Length of the description is limited to 1024 characters.",
"type": "string"
},
"displayName": {
"description": "Display name for this patch job. This does not have to be unique.",
"type": "string"
},
"dryRun": {
"type": "boolean",
"description": "If this patch is a dry-run only, instances are contacted but will do nothing."
},
"instanceFilter": {
"$ref": "PatchInstanceFilter",
"description": "Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels."
},
"patchConfig": {
"description": "Patch configuration being applied. If omitted, instances are patched using the default configurations.",
"$ref": "PatchConfig"
},
"duration": {
"format": "google-duration",
"description": "Duration of the patch job. After the duration ends, the patch job times out.",
"type": "string"
},
"rollout": {
"$ref": "PatchRollout",
"description": "Rollout strategy of the patch job."
}
},
"type": "object",
"description": "A request message to initiate patching across Compute Engine instances."
},
"GooRepository": {
"type": "object",
"id": "GooRepository",
"properties": {
"name": {
"type": "string",
"description": "Required. The name of the repository."
},
"url": {
"description": "Required. The url of the repository.",
"type": "string"
}
},
"description": "Represents a Goo package repository. These is added to a repo file that is stored at C:/ProgramData/GooGet/repos/google_osconfig.repo."
}
},
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/compute/docs/manage-os",
"protocol": "rest",
"fullyEncodeReservedExpansion": true,
"mtlsRootUrl": "https://osconfig.mtls.googleapis.com/"
}