{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
},
"basePath": "",
"baseUrl": "https://osconfig.googleapis.com/",
"batchPath": "batch",
"canonicalName": "OS Config",
"description": "OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/compute/docs/osconfig/rest",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "osconfig:v1alpha",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://osconfig.mtls.googleapis.com/",
"name": "osconfig",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"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.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"locations": {
"resources": {
"instanceOSPoliciesCompliances": {
"deprecated": true,
"methods": {
"get": {
"deprecated": true,
"description": "Get OS policies compliance data for the specified Compute Engine VM instance.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/instanceOSPoliciesCompliances/{instanceOSPoliciesCompliancesId}",
"httpMethod": "GET",
"id": "osconfig.projects.locations.instanceOSPoliciesCompliances.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. API resource name for instance OS policies compliance resource. Format: `projects/{project}/locations/{location}/instanceOSPoliciesCompliances/{instance}` For `{project}`, either Compute Engine project-number or project-id can be provided. For `{instance}`, either Compute Engine VM instance-id or instance-name can be provided.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instanceOSPoliciesCompliances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "InstanceOSPoliciesCompliance"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"deprecated": true,
"description": "List OS policies compliance data for all Compute Engine VM instances in the specified zone.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/instanceOSPoliciesCompliances",
"httpMethod": "GET",
"id": "osconfig.projects.locations.instanceOSPoliciesCompliances.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "If provided, this field specifies the criteria that must be met by a `InstanceOSPoliciesCompliance` API resource to be included in the response.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call to `ListInstanceOSPoliciesCompliances` that indicates where this listing should continue from.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}` For `{project}`, either Compute Engine project-number or project-id can be provided.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+parent}/instanceOSPoliciesCompliances",
"response": {
"$ref": "ListInstanceOSPoliciesCompliancesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"instances": {
"resources": {
"inventories": {
"methods": {
"get": {
"description": "Get inventory data for the specified VM instance. If the VM has no associated inventory, the message `NOT_FOUND` is returned.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/inventory",
"httpMethod": "GET",
"id": "osconfig.projects.locations.instances.inventories.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. API resource name for inventory resource. Format: `projects/{project}/locations/{location}/instances/{instance}/inventory` For `{project}`, either `project-number` or `project-id` can be provided. For `{instance}`, either Compute Engine `instance-id` or `instance-name` can be provided.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/inventory$",
"required": true,
"type": "string"
},
"view": {
"description": "Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.",
"enum": [
"INVENTORY_VIEW_UNSPECIFIED",
"BASIC",
"FULL"
],
"enumDescriptions": [
"The default value. The API defaults to the BASIC view.",
"Returns the basic inventory information that includes `os_info`.",
"Returns all fields."
],
"location": "query",
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "Inventory"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "List inventory data for all VM instances in the specified zone.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/inventories",
"httpMethod": "GET",
"id": "osconfig.projects.locations.instances.inventories.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "If provided, this field specifies the criteria that must be met by a `Inventory` API resource to be included in the response.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call to `ListInventories` that indicates where this listing should continue from.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/instances/-` For `{project}`, either `project-number` or `project-id` can be provided.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
},
"view": {
"description": "Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.",
"enum": [
"INVENTORY_VIEW_UNSPECIFIED",
"BASIC",
"FULL"
],
"enumDescriptions": [
"The default value. The API defaults to the BASIC view.",
"Returns the basic inventory information that includes `os_info`.",
"Returns all fields."
],
"location": "query",
"type": "string"
}
},
"path": "v1alpha/{+parent}/inventories",
"response": {
"$ref": "ListInventoriesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"osPolicyAssignments": {
"resources": {
"reports": {
"methods": {
"get": {
"description": "Get the OS policy assignment report for the specified Compute Engine VM instance.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/osPolicyAssignments/{osPolicyAssignmentsId}/report",
"httpMethod": "GET",
"id": "osconfig.projects.locations.instances.osPolicyAssignments.reports.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. API resource name for OS policy assignment report. Format: `/projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report` For `{project}`, either `project-number` or `project-id` can be provided. For `{instance_id}`, either Compute Engine `instance-id` or `instance-name` can be provided. For `{assignment_id}`, the OSPolicyAssignment id must be provided.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/osPolicyAssignments/[^/]+/report$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "OSPolicyAssignmentReport"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "List OS policy assignment reports for all Compute Engine VM instances in the specified zone.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/osPolicyAssignments/{osPolicyAssignmentsId}/reports",
"httpMethod": "GET",
"id": "osconfig.projects.locations.instances.osPolicyAssignments.reports.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "If provided, this field specifies the criteria that must be met by the `OSPolicyAssignmentReport` API resource that is included in the response.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call to the `ListOSPolicyAssignmentReports` method that indicates where this listing should continue from.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/reports` For `{project}`, either `project-number` or `project-id` can be provided. For `{instance}`, either `instance-name`, `instance-id`, or `-` can be provided. If '-' is provided, the response will include OSPolicyAssignmentReports for all instances in the project/location. For `{assignment}`, either `assignment-id` or `-` can be provided. If '-' is provided, the response will include OSPolicyAssignmentReports for all OSPolicyAssignments in the project/location. Either {instance} or {assignment} must be `-`. For example: `projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/-/reports` returns all reports for the instance `projects/{project}/locations/{location}/instances/-/osPolicyAssignments/{assignment-id}/reports` returns all the reports for the given assignment across all instances. `projects/{project}/locations/{location}/instances/-/osPolicyAssignments/-/reports` returns all the reports for all assignments across all instances.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/osPolicyAssignments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+parent}/reports",
"response": {
"$ref": "ListOSPolicyAssignmentReportsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"vulnerabilityReports": {
"methods": {
"get": {
"description": "Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/vulnerabilityReport",
"httpMethod": "GET",
"id": "osconfig.projects.locations.instances.vulnerabilityReports.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. API resource name for vulnerability resource. Format: `projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport` For `{project}`, either `project-number` or `project-id` can be provided. For `{instance}`, either Compute Engine `instance-id` or `instance-name` can be provided.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/vulnerabilityReport$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "VulnerabilityReport"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "List vulnerability reports for all VM instances in the specified zone.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/vulnerabilityReports",
"httpMethod": "GET",
"id": "osconfig.projects.locations.instances.vulnerabilityReports.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "This field supports filtering by the severity level for the vulnerability. For a list of severity levels, see [Severity levels for vulnerabilities](https://cloud.google.com/container-analysis/docs/container-scanning-overview#severity_levels_for_vulnerabilities). The filter field follows the rules described in the [AIP-160](https://google.aip.dev/160) guidelines as follows: + **Filter for a specific severity type**: you can list reports that contain vulnerabilities that are classified as medium by specifying `vulnerabilities.details.severity:MEDIUM`. + **Filter for a range of severities** : you can list reports that have vulnerabilities that are classified as critical or high by specifying `vulnerabilities.details.severity:HIGH OR vulnerabilities.details.severity:CRITICAL`",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call to `ListVulnerabilityReports` that indicates where this listing should continue from.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/instances/-` For `{project}`, either `project-number` or `project-id` can be provided.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+parent}/vulnerabilityReports",
"response": {
"$ref": "ListVulnerabilityReportsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "osconfig.projects.locations.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}:cancel",
"request": {
"$ref": "CancelOperationRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "osconfig.projects.locations.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "osconfig.projects.locations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "osconfig.projects.locations.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
},
"returnPartialSuccess": {
"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
"location": "query",
"type": "boolean"
}
},
"path": "v1alpha/{+name}/operations",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"osPolicyAssignments": {
"methods": {
"create": {
"description": "Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments",
"httpMethod": "POST",
"id": "osconfig.projects.locations.osPolicyAssignments.create",
"parameterOrder": [
"parent"
],
"parameters": {
"osPolicyAssignmentId": {
"description": "Required. The logical name of the OS policy assignment 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.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name in the form: projects/{project}/locations/{location}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided.",
"location": "query",
"type": "string"
}
},
"path": "v1alpha/{+parent}/osPolicyAssignments",
"request": {
"$ref": "OSPolicyAssignment"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments/{osPolicyAssignmentsId}",
"httpMethod": "DELETE",
"id": "osconfig.projects.locations.osPolicyAssignments.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the OS policy assignment to be deleted",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/osPolicyAssignments/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided.",
"location": "query",
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Retrieve an existing OS policy assignment. This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID in the `name` parameter.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments/{osPolicyAssignmentsId}",
"httpMethod": "GET",
"id": "osconfig.projects.locations.osPolicyAssignments.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of OS policy assignment. Format: `projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}@{revisionId}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/osPolicyAssignments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "OSPolicyAssignment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments",
"httpMethod": "GET",
"id": "osconfig.projects.locations.osPolicyAssignments.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of assignments to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call to `ListOSPolicyAssignments` that indicates where this listing should continue from.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+parent}/osPolicyAssignments",
"response": {
"$ref": "ListOSPolicyAssignmentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"listRevisions": {
"description": "List the OS policy assignment revisions for a given OS policy assignment.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments/{osPolicyAssignmentsId}:listRevisions",
"httpMethod": "GET",
"id": "osconfig.projects.locations.osPolicyAssignments.listRevisions",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the OS policy assignment to list revisions for.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/osPolicyAssignments/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The maximum number of revisions to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call to `ListOSPolicyAssignmentRevisions` that indicates where this listing should continue from.",
"location": "query",
"type": "string"
}
},
"path": "v1alpha/{+name}:listRevisions",
"response": {
"$ref": "ListOSPolicyAssignmentRevisionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments/{osPolicyAssignmentsId}",
"httpMethod": "PATCH",
"id": "osconfig.projects.locations.osPolicyAssignments.patch",
"parameterOrder": [
"name"
],
"parameters": {
"allowMissing": {
"description": "Optional. If set to true, and the OS policy assignment is not found, a new OS policy assignment will be created. In this situation, `update_mask` is ignored.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` This field is ignored when you create an OS policy assignment.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/osPolicyAssignments/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided.",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "Optional. Field mask that controls which fields of the assignment should be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1alpha/{+name}",
"request": {
"$ref": "OSPolicyAssignment"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments/{osPolicyAssignmentsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "osconfig.projects.locations.osPolicyAssignments.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/osPolicyAssignments/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}:cancel",
"request": {
"$ref": "CancelOperationRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments/{osPolicyAssignmentsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "osconfig.projects.locations.osPolicyAssignments.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/osPolicyAssignments/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
}
}
},
"revision": "20260108",
"rootUrl": "https://osconfig.googleapis.com/",
"schemas": {
"CVSSv3": {
"description": "Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document",
"id": "CVSSv3",
"properties": {
"attackComplexity": {
"description": "This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability.",
"enum": [
"ATTACK_COMPLEXITY_UNSPECIFIED",
"ATTACK_COMPLEXITY_LOW",
"ATTACK_COMPLEXITY_HIGH"
],
"enumDescriptions": [
"Invalid value.",
"Specialized access conditions or extenuating circumstances do not exist. An attacker can expect repeatable success when attacking the vulnerable component.",
"A successful attack depends on conditions beyond the attacker's control. That is, a successful attack cannot be accomplished at will, but requires the attacker to invest in some measurable amount of effort in preparation or execution against the vulnerable component before a successful attack can be expected."
],
"type": "string"
},
"attackVector": {
"description": "This metric reflects the context by which vulnerability exploitation is possible.",
"enum": [
"ATTACK_VECTOR_UNSPECIFIED",
"ATTACK_VECTOR_NETWORK",
"ATTACK_VECTOR_ADJACENT",
"ATTACK_VECTOR_LOCAL",
"ATTACK_VECTOR_PHYSICAL"
],
"enumDescriptions": [
"Invalid value.",
"The vulnerable component is bound to the network stack and the set of possible attackers extends beyond the other options listed below, up to and including the entire Internet.",
"The vulnerable component is bound to the network stack, but the attack is limited at the protocol level to a logically adjacent topology.",
"The vulnerable component is not bound to the network stack and the attacker's path is via read/write/execute capabilities.",
"The attack requires the attacker to physically touch or manipulate the vulnerable component."
],
"type": "string"
},
"availabilityImpact": {
"description": "This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability.",
"enum": [
"IMPACT_UNSPECIFIED",
"IMPACT_HIGH",
"IMPACT_LOW",
"IMPACT_NONE"
],
"enumDescriptions": [
"Invalid value.",
"High impact.",
"Low impact.",
"No impact."
],
"type": "string"
},
"baseScore": {
"description": "The base score is a function of the base metric scores. https://www.first.org/cvss/specification-document#Base-Metrics",
"format": "float",
"type": "number"
},
"confidentialityImpact": {
"description": "This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability.",
"enum": [
"IMPACT_UNSPECIFIED",
"IMPACT_HIGH",
"IMPACT_LOW",
"IMPACT_NONE"
],
"enumDescriptions": [
"Invalid value.",
"High impact.",
"Low impact.",
"No impact."
],
"type": "string"
},
"exploitabilityScore": {
"description": "The Exploitability sub-score equation is derived from the Base Exploitability metrics. https://www.first.org/cvss/specification-document#2-1-Exploitability-Metrics",
"format": "float",
"type": "number"
},
"impactScore": {
"description": "The Impact sub-score equation is derived from the Base Impact metrics.",
"format": "float",
"type": "number"
},
"integrityImpact": {
"description": "This metric measures the impact to integrity of a successfully exploited vulnerability.",
"enum": [
"IMPACT_UNSPECIFIED",
"IMPACT_HIGH",
"IMPACT_LOW",
"IMPACT_NONE"
],
"enumDescriptions": [
"Invalid value.",
"High impact.",
"Low impact.",
"No impact."
],
"type": "string"
},
"privilegesRequired": {
"description": "This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.",
"enum": [
"PRIVILEGES_REQUIRED_UNSPECIFIED",
"PRIVILEGES_REQUIRED_NONE",
"PRIVILEGES_REQUIRED_LOW",
"PRIVILEGES_REQUIRED_HIGH"
],
"enumDescriptions": [
"Invalid value.",
"The attacker is unauthorized prior to attack, and therefore does not require any access to settings or files of the vulnerable system to carry out an attack.",
"The attacker requires privileges that provide basic user capabilities that could normally affect only settings and files owned by a user. Alternatively, an attacker with Low privileges has the ability to access only non-sensitive resources.",
"The attacker requires privileges that provide significant (e.g., administrative) control over the vulnerable component allowing access to component-wide settings and files."
],
"type": "string"
},
"scope": {
"description": "The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.",
"enum": [
"SCOPE_UNSPECIFIED",
"SCOPE_UNCHANGED",
"SCOPE_CHANGED"
],
"enumDescriptions": [
"Invalid value.",
"An exploited vulnerability can only affect resources managed by the same security authority.",
"An exploited vulnerability can affect resources beyond the security scope managed by the security authority of the vulnerable component."
],
"type": "string"
},
"userInteraction": {
"description": "This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.",
"enum": [
"USER_INTERACTION_UNSPECIFIED",
"USER_INTERACTION_NONE",
"USER_INTERACTION_REQUIRED"
],
"enumDescriptions": [
"Invalid value.",
"The vulnerable system can be exploited without interaction from any user.",
"Successful exploitation of this vulnerability requires a user to take some action before the vulnerability can be exploited."
],
"type": "string"
}
},
"type": "object"
},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"id": "CancelOperationRequest",
"properties": {},
"type": "object"
},
"Date": {
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
"id": "Date",
"properties": {
"day": {
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
"format": "int32",
"type": "integer"
},
"month": {
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
"format": "int32",
"type": "integer"
},
"year": {
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"Empty": {
"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); }",
"id": "Empty",
"properties": {},
"type": "object"
},
"FixedOrPercent": {
"description": "Message encapsulating a value that can be either absolute (\"fixed\") or relative (\"percent\") to a value.",
"id": "FixedOrPercent",
"properties": {
"fixed": {
"description": "Specifies a fixed value.",
"format": "int32",
"type": "integer"
},
"percent": {
"description": "Specifies the relative value defined as a percentage, which will be multiplied by a reference value.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudOsconfigCommonV1__OperationMetadata": {
"description": "Represents the metadata of a generic long-running operation.",
"id": "GoogleCloudOsconfigCommonV1__OperationMetadata",
"properties": {
"apiVersion": {
"description": "Output only. API version used to start the operation.",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The time the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"requestedCancellation": {
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"readOnly": true,
"type": "boolean"
},
"statusMessage": {
"description": "Output only. Human-readable status of the operation, if any.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Output only. Server-defined resource path for the target of the operation.",
"readOnly": true,
"type": "string"
},
"verb": {
"description": "Output only. Name of the verb executed by the operation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudOsconfigCommonV1alpha__OperationMetadata": {
"description": "Represents the metadata of a generic long-running operation.",
"id": "GoogleCloudOsconfigCommonV1alpha__OperationMetadata",
"properties": {
"apiVersion": {
"description": "Output only. API version used to start the operation.",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The time the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"requestedCancellation": {
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"readOnly": true,
"type": "boolean"
},
"statusMessage": {
"description": "Output only. Human-readable status of the operation, if any.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Output only. Server-defined resource path for the target of the operation.",
"readOnly": true,
"type": "string"
},
"verb": {
"description": "Output only. Name of the verb executed by the operation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudOsconfigCommonV1main__OperationMetadata": {
"description": "Represents the metadata of a generic long-running operation.",
"id": "GoogleCloudOsconfigCommonV1main__OperationMetadata",
"properties": {
"apiVersion": {
"description": "Output only. API version used to start the operation.",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The time the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"requestedCancellation": {
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"readOnly": true,
"type": "boolean"
},
"statusMessage": {
"description": "Output only. Human-readable status of the operation, if any.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Output only. Server-defined resource path for the target of the operation.",
"readOnly": true,
"type": "string"
},
"verb": {
"description": "Output only. Name of the verb executed by the operation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata": {
"description": "OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.",
"id": "GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata",
"properties": {
"apiMethod": {
"description": "The OS policy assignment API method.",
"enum": [
"API_METHOD_UNSPECIFIED",
"CREATE",
"UPDATE",
"DELETE"
],
"enumDescriptions": [
"Invalid value",
"Create OS policy assignment API method",
"Update OS policy assignment API method",
"Delete OS policy assignment API method"
],
"type": "string"
},
"osPolicyAssignment": {
"description": "Reference to the `OSPolicyAssignment` API resource. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`",
"type": "string"
},
"rolloutStartTime": {
"description": "Rollout start time",
"format": "google-datetime",
"type": "string"
},
"rolloutState": {
"description": "State of the rollout",
"enum": [
"ROLLOUT_STATE_UNSPECIFIED",
"IN_PROGRESS",
"CANCELLING",
"CANCELLED",
"SUCCEEDED"
],
"enumDescriptions": [
"Invalid value",
"The rollout is in progress.",
"The rollout is being cancelled.",
"The rollout is cancelled.",
"The rollout has completed successfully."
],
"type": "string"
},
"rolloutUpdateTime": {
"description": "Rollout update time",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudOsconfigV2__OperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
"id": "GoogleCloudOsconfigV2__OperationMetadata",
"properties": {
"apiVersion": {
"description": "Output only. API version used to start the operation.",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The time the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"requestedCancellation": {
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"readOnly": true,
"type": "boolean"
},
"statusMessage": {
"description": "Output only. Human-readable status of the operation, if any.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Output only. Server-defined resource path for the target of the operation.",
"readOnly": true,
"type": "string"
},
"verb": {
"description": "Output only. Name of the verb executed by the operation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudOsconfigV2beta__OperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
"id": "GoogleCloudOsconfigV2beta__OperationMetadata",
"properties": {
"apiVersion": {
"description": "Output only. API version used to start the operation.",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The time the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"requestedCancellation": {
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"readOnly": true,
"type": "boolean"
},
"statusMessage": {
"description": "Output only. Human-readable status of the operation, if any.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Output only. Server-defined resource path for the target of the operation.",
"readOnly": true,
"type": "string"
},
"verb": {
"description": "Output only. Name of the verb executed by the operation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InstanceOSPoliciesCompliance": {
"deprecated": true,
"description": "This API resource represents the OS policies compliance data for a Compute Engine virtual machine (VM) instance at a given point in time. A Compute Engine VM can have multiple OS policy assignments, and each assignment can have multiple OS policies. As a result, multiple OS policies could be applied to a single VM. You can use this API resource to determine both the compliance state of your VM as well as the compliance state of an individual OS policy. For more information, see [View compliance](https://cloud.google.com/compute/docs/os-configuration-management/view-compliance).",
"id": "InstanceOSPoliciesCompliance",
"properties": {
"detailedState": {
"description": "Output only. Detailed compliance state of the VM. This field is populated only when compliance state is `UNKNOWN`. It may contain one of the following values: * `no-compliance-data`: Compliance data is not available for this VM. * `no-agent-detected`: OS Config agent is not detected for this VM. * `config-not-supported-by-agent`: The version of the OS Config agent running on this VM does not support configuration management. * `inactive`: VM is not running. * `internal-service-errors`: There were internal service errors encountered while enforcing compliance. * `agent-errors`: OS config agent encountered errors while enforcing compliance.",
"readOnly": true,
"type": "string"
},
"detailedStateReason": {
"description": "Output only. The reason for the `detailed_state` of the VM (if any).",
"readOnly": true,
"type": "string"
},
"instance": {
"description": "Output only. The Compute Engine VM instance name.",
"readOnly": true,
"type": "string"
},
"lastComplianceCheckTime": {
"description": "Output only. Timestamp of the last compliance check for the VM.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"lastComplianceRunId": {
"description": "Output only. Unique identifier for the last compliance run. This id will be logged by the OS config agent during a compliance run and can be used for debugging and tracing purpose.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The `InstanceOSPoliciesCompliance` API resource name. Format: `projects/{project_number}/locations/{location}/instanceOSPoliciesCompliances/{instance_id}`",
"readOnly": true,
"type": "string"
},
"osPolicyCompliances": {
"description": "Output only. Compliance data for each `OSPolicy` that is applied to the VM.",
"items": {
"$ref": "InstanceOSPoliciesComplianceOSPolicyCompliance"
},
"readOnly": true,
"type": "array"
},
"state": {
"description": "Output only. Compliance state of the VM.",
"enum": [
"OS_POLICY_COMPLIANCE_STATE_UNSPECIFIED",
"COMPLIANT",
"NON_COMPLIANT",
"UNKNOWN",
"NO_OS_POLICIES_APPLICABLE"
],
"enumDescriptions": [
"Default value. This value is unused.",
"Compliant state.",
"Non-compliant state",
"Unknown compliance state.",
"No applicable OS policies were found for the instance. This state is only applicable to the instance."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InstanceOSPoliciesComplianceOSPolicyCompliance": {
"deprecated": true,
"description": "Compliance data for an OS policy",
"id": "InstanceOSPoliciesComplianceOSPolicyCompliance",
"properties": {
"osPolicyAssignment": {
"description": "Reference to the `OSPolicyAssignment` API resource that the `OSPolicy` belongs to. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`",
"type": "string"
},
"osPolicyId": {
"description": "The OS policy id",
"type": "string"
},
"osPolicyResourceCompliances": {
"description": "Compliance data for each `OSPolicyResource` that is applied to the VM.",
"items": {
"$ref": "OSPolicyResourceCompliance"
},
"type": "array"
},
"state": {
"description": "Compliance state of the OS policy.",
"enum": [
"OS_POLICY_COMPLIANCE_STATE_UNSPECIFIED",
"COMPLIANT",
"NON_COMPLIANT",
"UNKNOWN",
"NO_OS_POLICIES_APPLICABLE"
],
"enumDescriptions": [
"Default value. This value is unused.",
"Compliant state.",
"Non-compliant state",
"Unknown compliance state.",
"No applicable OS policies were found for the instance. This state is only applicable to the instance."
],
"type": "string"
}
},
"type": "object"
},
"Inventory": {
"description": "This API resource represents the available inventory data for a Compute Engine virtual machine (VM) instance at a given point in time. You can use this API resource to determine the inventory data of your VM. For more information, see [Information provided by OS inventory management](https://cloud.google.com/compute/docs/instances/os-inventory-management#data-collected).",
"id": "Inventory",
"properties": {
"items": {
"additionalProperties": {
"$ref": "InventoryItem"
},
"description": "Output only. 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.",
"readOnly": true,
"type": "object"
},
"name": {
"description": "Output only. The `Inventory` API resource name. Format: `projects/{project_number}/locations/{location}/instances/{instance_id}/inventory`",
"readOnly": true,
"type": "string"
},
"osInfo": {
"$ref": "InventoryOsInfo",
"description": "Output only. Base level operating system information for the VM.",
"readOnly": true
},
"updateTime": {
"description": "Output only. Timestamp of the last reported inventory for the VM.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InventoryItem": {
"description": "A single piece of inventory on a VM.",
"id": "InventoryItem",
"properties": {
"availablePackage": {
"$ref": "InventorySoftwarePackage",
"description": "Software package available to be installed on the VM instance."
},
"createTime": {
"description": "When this inventory item was first detected.",
"format": "google-datetime",
"type": "string"
},
"id": {
"description": "Identifier for this item, unique across items for this VM.",
"type": "string"
},
"installedPackage": {
"$ref": "InventorySoftwarePackage",
"description": "Software package present on the VM instance."
},
"originType": {
"description": "The origin of this inventory item.",
"enum": [
"ORIGIN_TYPE_UNSPECIFIED",
"INVENTORY_REPORT"
],
"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."
],
"type": "string"
},
"type": {
"description": "The specific type of inventory, correlating to its specific details.",
"enum": [
"TYPE_UNSPECIFIED",
"INSTALLED_PACKAGE",
"AVAILABLE_PACKAGE"
],
"enumDescriptions": [
"Invalid. A type must be specified.",
"This represents a package that is installed on the VM.",
"This represents an update that is available for a package."
],
"type": "string"
},
"updateTime": {
"description": "When this inventory item was last modified.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"InventoryOsInfo": {
"description": "Operating system information for the VM.",
"id": "InventoryOsInfo",
"properties": {
"architecture": {
"description": "The system architecture of the operating system.",
"type": "string"
},
"hostname": {
"description": "The VM hostname.",
"type": "string"
},
"kernelRelease": {
"description": "The kernel release of the operating system.",
"type": "string"
},
"kernelVersion": {
"description": "The kernel version 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"
},
"osconfigAgentVersion": {
"description": "The current version of the OS Config agent running on the VM.",
"type": "string"
},
"shortName": {
"description": "The operating system short name. For example, 'windows' or 'debian'.",
"type": "string"
},
"version": {
"description": "The version of the operating system.",
"type": "string"
}
},
"type": "object"
},
"InventorySoftwarePackage": {
"description": "Software package information of the operating system.",
"id": "InventorySoftwarePackage",
"properties": {
"aptPackage": {
"$ref": "InventoryVersionedPackage",
"description": "Details of an APT package. For details about the apt package manager, see https://wiki.debian.org/Apt."
},
"cosPackage": {
"$ref": "InventoryVersionedPackage",
"description": "Details of a COS package."
},
"googetPackage": {
"$ref": "InventoryVersionedPackage",
"description": "Details of a Googet package. For details about the googet package manager, see https://github.com/google/googet."
},
"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."
},
"windowsApplication": {
"$ref": "InventoryWindowsApplication",
"description": "Details of Windows Application."
},
"wuaPackage": {
"$ref": "InventoryWindowsUpdatePackage",
"description": "Details of a Windows Update package. See https://docs.microsoft.com/en-us/windows/win32/api/_wua/ for information about Windows Update."
},
"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."
},
"zypperPackage": {
"$ref": "InventoryVersionedPackage",
"description": "Details of a Zypper package. For details about the Zypper package manager, see https://en.opensuse.org/SDB:Zypper_manual."
},
"zypperPatch": {
"$ref": "InventoryZypperPatch",
"description": "Details of a Zypper patch. For details about the Zypper package manager, see https://en.opensuse.org/SDB:Zypper_manual."
}
},
"type": "object"
},
"InventoryVersionedPackage": {
"description": "Information related to the a standard versioned package. This includes package info for APT, Yum, Zypper, and Googet package managers.",
"id": "InventoryVersionedPackage",
"properties": {
"architecture": {
"description": "The system architecture this package is intended for.",
"type": "string"
},
"packageName": {
"description": "The name of the package.",
"type": "string"
},
"version": {
"description": "The version of the package.",
"type": "string"
}
},
"type": "object"
},
"InventoryWindowsApplication": {
"description": "Contains information about a Windows application that is retrieved from the Windows Registry. For more information about these fields, see: https://docs.microsoft.com/en-us/windows/win32/msi/uninstall-registry-key",
"id": "InventoryWindowsApplication",
"properties": {
"displayName": {
"description": "The name of the application or product.",
"type": "string"
},
"displayVersion": {
"description": "The version of the product or application in string format.",
"type": "string"
},
"helpLink": {
"description": "The internet address for technical support.",
"type": "string"
},
"installDate": {
"$ref": "Date",
"description": "The last time this product received service. The value of this property is replaced each time a patch is applied or removed from the product or the command-line option is used to repair the product."
},
"publisher": {
"description": "The name of the manufacturer for the product or application.",
"type": "string"
}
},
"type": "object"
},
"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",
"id": "InventoryWindowsQuickFixEngineeringPackage",
"properties": {
"caption": {
"description": "A short textual description of the QFE update.",
"type": "string"
},
"description": {
"description": "A textual description of the QFE update.",
"type": "string"
},
"hotFixId": {
"description": "Unique identifier associated with a particular QFE update.",
"type": "string"
},
"installTime": {
"description": "Date that the QFE update was installed. Mapped from installed_on field.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"InventoryWindowsUpdatePackage": {
"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.",
"id": "InventoryWindowsUpdatePackage",
"properties": {
"categories": {
"description": "The categories that are associated with this update package.",
"items": {
"$ref": "InventoryWindowsUpdatePackageWindowsUpdateCategory"
},
"type": "array"
},
"description": {
"description": "The localized description of the update package.",
"type": "string"
},
"kbArticleIds": {
"description": "A collection of Microsoft Knowledge Base article IDs that are associated with the update package.",
"items": {
"type": "string"
},
"type": "array"
},
"lastDeploymentChangeTime": {
"description": "The last published date of the update, in (UTC) date and time.",
"format": "google-datetime",
"type": "string"
},
"moreInfoUrls": {
"description": "A collection of URLs that provide more information about the update package.",
"items": {
"type": "string"
},
"type": "array"
},
"revisionNumber": {
"description": "The revision number of this update package.",
"format": "int32",
"type": "integer"
},
"supportUrl": {
"description": "A hyperlink to the language-specific support information for the update.",
"type": "string"
},
"title": {
"description": "The localized title of the update package.",
"type": "string"
},
"updateId": {
"description": "Gets the identifier of an update package. Stays the same across revisions.",
"type": "string"
}
},
"type": "object"
},
"InventoryWindowsUpdatePackageWindowsUpdateCategory": {
"description": "Categories specified by the Windows Update.",
"id": "InventoryWindowsUpdatePackageWindowsUpdateCategory",
"properties": {
"id": {
"description": "The identifier of the windows update category.",
"type": "string"
},
"name": {
"description": "The name of the windows update category.",
"type": "string"
}
},
"type": "object"
},
"InventoryZypperPatch": {
"description": "Details related to a Zypper Patch.",
"id": "InventoryZypperPatch",
"properties": {
"category": {
"description": "The category of the patch.",
"type": "string"
},
"patchName": {
"description": "The name of the patch.",
"type": "string"
},
"severity": {
"description": "The severity specified for this patch",
"type": "string"
},
"summary": {
"description": "Any summary information provided about this patch.",
"type": "string"
}
},
"type": "object"
},
"ListInstanceOSPoliciesCompliancesResponse": {
"deprecated": true,
"description": "A response message for listing OS policies compliance data for all Compute Engine VMs in the given location.",
"id": "ListInstanceOSPoliciesCompliancesResponse",
"properties": {
"instanceOsPoliciesCompliances": {
"description": "List of instance OS policies compliance objects.",
"items": {
"$ref": "InstanceOSPoliciesCompliance"
},
"type": "array"
},
"nextPageToken": {
"description": "The pagination token to retrieve the next page of instance OS policies compliance objects.",
"type": "string"
}
},
"type": "object"
},
"ListInventoriesResponse": {
"description": "A response message for listing inventory data for all VMs in a specified location.",
"id": "ListInventoriesResponse",
"properties": {
"inventories": {
"description": "List of inventory objects.",
"items": {
"$ref": "Inventory"
},
"type": "array"
},
"nextPageToken": {
"description": "The pagination token to retrieve the next page of inventory objects.",
"type": "string"
}
},
"type": "object"
},
"ListOSPolicyAssignmentReportsResponse": {
"description": "A response message for listing OS Policy assignment reports including the page of results and page token.",
"id": "ListOSPolicyAssignmentReportsResponse",
"properties": {
"nextPageToken": {
"description": "The pagination token to retrieve the next page of OS policy assignment report objects.",
"type": "string"
},
"osPolicyAssignmentReports": {
"description": "List of OS policy assignment reports.",
"items": {
"$ref": "OSPolicyAssignmentReport"
},
"type": "array"
}
},
"type": "object"
},
"ListOSPolicyAssignmentRevisionsResponse": {
"description": "A response message for listing all revisions for a OS policy assignment.",
"id": "ListOSPolicyAssignmentRevisionsResponse",
"properties": {
"nextPageToken": {
"description": "The pagination token to retrieve the next page of OS policy assignment revisions.",
"type": "string"
},
"osPolicyAssignments": {
"description": "The OS policy assignment revisions",
"items": {
"$ref": "OSPolicyAssignment"
},
"type": "array"
}
},
"type": "object"
},
"ListOSPolicyAssignmentsResponse": {
"description": "A response message for listing all assignments under given parent.",
"id": "ListOSPolicyAssignmentsResponse",
"properties": {
"nextPageToken": {
"description": "The pagination token to retrieve the next page of OS policy assignments.",
"type": "string"
},
"osPolicyAssignments": {
"description": "The list of assignments",
"items": {
"$ref": "OSPolicyAssignment"
},
"type": "array"
}
},
"type": "object"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "ListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
},
"unreachable": {
"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListVulnerabilityReportsResponse": {
"description": "A response message for listing vulnerability reports for all VM instances in the specified location.",
"id": "ListVulnerabilityReportsResponse",
"properties": {
"nextPageToken": {
"description": "The pagination token to retrieve the next page of vulnerabilityReports object.",
"type": "string"
},
"vulnerabilityReports": {
"description": "List of vulnerabilityReport objects.",
"items": {
"$ref": "VulnerabilityReport"
},
"type": "array"
}
},
"type": "object"
},
"MessageSet": {
"deprecated": true,
"description": "This is proto2's version of MessageSet. DEPRECATED: DO NOT USE FOR NEW FIELDS. If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use `Any` instead. MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a \"bridge\" solution to migrate MessageSet-bearing messages from proto1 to proto2. This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments.",
"id": "MessageSet",
"properties": {},
"type": "object"
},
"OSPolicy": {
"description": "An OS policy defines the desired state configuration for a VM.",
"id": "OSPolicy",
"properties": {
"allowNoResourceGroupMatch": {
"description": "This flag determines the OS policy compliance status when none of the resource groups within the policy are applicable for a VM. Set this value to `true` if the policy needs to be reported as compliant even if the policy has nothing to validate or enforce.",
"type": "boolean"
},
"description": {
"description": "Policy description. Length of the description is limited to 1024 characters.",
"type": "string"
},
"id": {
"description": "Required. The id of the OS policy 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 assignment.",
"type": "string"
},
"mode": {
"description": "Required. Policy mode",
"enum": [
"MODE_UNSPECIFIED",
"VALIDATION",
"ENFORCEMENT"
],
"enumDescriptions": [
"Invalid mode",
"This mode checks if the configuration resources in the policy are in their desired state. No actions are performed if they are not in the desired state. This mode is used for reporting purposes.",
"This mode checks if the configuration resources in the policy are in their desired state, and if not, enforces the desired state."
],
"type": "string"
},
"resourceGroups": {
"description": "Required. List of resource groups for the policy. For a particular VM, resource groups are evaluated in the order specified and the first resource group that is applicable is selected and the rest are ignored. If none of the resource groups are applicable for a VM, the VM is considered to be non-compliant w.r.t this policy. This behavior can be toggled by the flag `allow_no_resource_group_match`",
"items": {
"$ref": "OSPolicyResourceGroup"
},
"type": "array"
}
},
"type": "object"
},
"OSPolicyAssignment": {
"description": "OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information, see [OS policy and OS policy assignment](https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies).",
"id": "OSPolicyAssignment",
"properties": {
"baseline": {
"description": "Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field.",
"readOnly": true,
"type": "boolean"
},
"deleted": {
"description": "Output only. Indicates that this revision deletes the OS policy assignment.",
"readOnly": true,
"type": "boolean"
},
"description": {
"description": "OS policy assignment description. Length of the description is limited to 1024 characters.",
"type": "string"
},
"etag": {
"description": "The etag for this OS policy assignment. If this is provided on update, it must match the server's etag.",
"type": "string"
},
"instanceFilter": {
"$ref": "OSPolicyAssignmentInstanceFilter",
"description": "Required. Filter to select VMs."
},
"name": {
"description": "Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` This field is ignored when you create an OS policy assignment.",
"type": "string"
},
"osPolicies": {
"description": "Required. List of OS policies to be applied to the VMs.",
"items": {
"$ref": "OSPolicy"
},
"type": "array"
},
"reconciling": {
"description": "Output only. Indicates that reconciliation is in progress for the revision. This value is `true` when the `rollout_state` is one of: * IN_PROGRESS * CANCELLING",
"readOnly": true,
"type": "boolean"
},
"revisionCreateTime": {
"description": "Output only. The timestamp that the revision was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"revisionId": {
"description": "Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment",
"readOnly": true,
"type": "string"
},
"rollout": {
"$ref": "OSPolicyAssignmentRollout",
"description": "Required. Rollout to deploy the OS policy assignment. A rollout is triggered in the following situations: 1) OSPolicyAssignment is created. 2) OSPolicyAssignment is updated and the update contains changes to one of the following fields: - instance_filter - os_policies 3) OSPolicyAssignment is deleted."
},
"rolloutState": {
"description": "Output only. OS policy assignment rollout state",
"enum": [
"ROLLOUT_STATE_UNSPECIFIED",
"IN_PROGRESS",
"CANCELLING",
"CANCELLED",
"SUCCEEDED"
],
"enumDescriptions": [
"Invalid value",
"The rollout is in progress.",
"The rollout is being cancelled.",
"The rollout is cancelled.",
"The rollout has completed successfully."
],
"readOnly": true,
"type": "string"
},
"uid": {
"description": "Output only. Server generated unique id for the OS policy assignment resource.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"OSPolicyAssignmentInstanceFilter": {
"description": "Filters to select target VMs for an assignment. If more than one filter criteria is specified below, a VM will be selected if and only if it satisfies all of them.",
"id": "OSPolicyAssignmentInstanceFilter",
"properties": {
"all": {
"description": "Target all VMs in the project. If true, no other criteria is permitted.",
"type": "boolean"
},
"exclusionLabels": {
"description": "List of label sets used for VM exclusion. If the list has more than one label set, the VM is excluded if any of the label sets are applicable for the VM.",
"items": {
"$ref": "OSPolicyAssignmentLabelSet"
},
"type": "array"
},
"inclusionLabels": {
"description": "List of label sets used for VM inclusion. If the list has more than one `LabelSet`, the VM is included if any of the label sets are applicable for the VM.",
"items": {
"$ref": "OSPolicyAssignmentLabelSet"
},
"type": "array"
},
"inventories": {
"description": "List of inventories to select VMs. A VM is selected if its inventory data matches at least one of the following inventories.",
"items": {
"$ref": "OSPolicyAssignmentInstanceFilterInventory"
},
"type": "array"
},
"osShortNames": {
"deprecated": true,
"description": "Deprecated. Use the `inventories` field instead. A VM is selected if it's OS short name matches with any of the values provided in this list.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"OSPolicyAssignmentInstanceFilterInventory": {
"description": "VM inventory details.",
"id": "OSPolicyAssignmentInstanceFilterInventory",
"properties": {
"osShortName": {
"description": "Required. The OS short name",
"type": "string"
},
"osVersion": {
"description": "The OS version Prefix matches are supported if asterisk(*) is provided as the last character. For example, to match all versions with a major version of `7`, specify the following value for this field `7.*` An empty string matches all OS versions.",
"type": "string"
}
},
"type": "object"
},
"OSPolicyAssignmentLabelSet": {
"description": "Message representing label set. * A label is a key value pair set for a VM. * A LabelSet is a set of labels. * Labels within a LabelSet are ANDed. In other words, a LabelSet is applicable for a VM only if it matches all the labels in the LabelSet. * Example: A LabelSet with 2 labels: `env=prod` and `type=webserver` will only be applicable for those VMs with both labels present.",
"id": "OSPolicyAssignmentLabelSet",
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are identified by key/value pairs in this map. A VM should contain all the key/value pairs specified in this map to be selected.",
"type": "object"
}
},
"type": "object"
},
"OSPolicyAssignmentOperationMetadata": {
"description": "OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.",
"id": "OSPolicyAssignmentOperationMetadata",
"properties": {
"apiMethod": {
"description": "The OS policy assignment API method.",
"enum": [
"API_METHOD_UNSPECIFIED",
"CREATE",
"UPDATE",
"DELETE"
],
"enumDescriptions": [
"Invalid value",
"Create OS policy assignment API method",
"Update OS policy assignment API method",
"Delete OS policy assignment API method"
],
"type": "string"
},
"osPolicyAssignment": {
"description": "Reference to the `OSPolicyAssignment` API resource. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`",
"type": "string"
},
"rolloutStartTime": {
"description": "Rollout start time",
"format": "google-datetime",
"type": "string"
},
"rolloutState": {
"description": "State of the rollout",
"enum": [
"ROLLOUT_STATE_UNSPECIFIED",
"IN_PROGRESS",
"CANCELLING",
"CANCELLED",
"SUCCEEDED"
],
"enumDescriptions": [
"Invalid value",
"The rollout is in progress.",
"The rollout is being cancelled.",
"The rollout is cancelled.",
"The rollout has completed successfully."
],
"type": "string"
},
"rolloutUpdateTime": {
"description": "Rollout update time",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"OSPolicyAssignmentReport": {
"description": "A report of the OS policy assignment status for a given instance.",
"id": "OSPolicyAssignmentReport",
"properties": {
"instance": {
"description": "The Compute Engine VM instance name.",
"type": "string"
},
"lastRunId": {
"description": "Unique identifier of the last attempted run to apply the OS policies associated with this assignment on the VM. This ID is logged by the OS Config agent while applying the OS policies associated with this assignment on the VM. NOTE: If the service is unable to successfully connect to the agent for this run, then this id will not be available in the agent logs.",
"type": "string"
},
"name": {
"description": "The `OSPolicyAssignmentReport` API resource name. Format: `projects/{project_number}/locations/{location}/instances/{instance_id}/osPolicyAssignments/{os_policy_assignment_id}/report`",
"type": "string"
},
"osPolicyAssignment": {
"description": "Reference to the `OSPolicyAssignment` API resource that the `OSPolicy` belongs to. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`",
"type": "string"
},
"osPolicyCompliances": {
"description": "Compliance data for each `OSPolicy` that is applied to the VM.",
"items": {
"$ref": "OSPolicyAssignmentReportOSPolicyCompliance"
},
"type": "array"
},
"updateTime": {
"description": "Timestamp for when the report was last generated.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"OSPolicyAssignmentReportOSPolicyCompliance": {
"description": "Compliance data for an OS policy",
"id": "OSPolicyAssignmentReportOSPolicyCompliance",
"properties": {
"complianceState": {
"description": "The compliance state of the OS policy.",
"enum": [
"UNKNOWN",
"COMPLIANT",
"NON_COMPLIANT"
],
"enumDescriptions": [
"The policy is in an unknown compliance state. Refer to the field `compliance_state_reason` to learn the exact reason for the policy to be in this compliance state.",
"Policy is compliant. The policy is compliant if all the underlying resources are also compliant.",
"Policy is non-compliant. The policy is non-compliant if one or more underlying resources are non-compliant."
],
"type": "string"
},
"complianceStateReason": {
"description": "The reason for the OS policy to be in an unknown compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. If populated, the field can contain one of the following values: * `vm-not-running`: The VM was not running. * `os-policies-not-supported-by-agent`: The version of the OS Config agent running on the VM does not support running OS policies. * `no-agent-detected`: The OS Config agent is not detected for the VM. * `resource-execution-errors`: The OS Config agent encountered errors while executing one or more resources in the policy. See `os_policy_resource_compliances` for details. * `task-timeout`: The task sent to the agent to apply the policy timed out. * `unexpected-agent-state`: The OS Config agent did not report the final status of the task that attempted to apply the policy. Instead, the agent unexpectedly started working on a different task. This mostly happens when the agent or VM unexpectedly restarts while applying OS policies. * `internal-service-errors`: Internal service errors were encountered while attempting to apply the policy. * `os-policy-execution-pending`: OS policy was assigned to the given VM, but was not executed yet. Typically this is a transient condition that will go away after the next policy execution cycle.",
"type": "string"
},
"osPolicyId": {
"description": "The OS policy id",
"type": "string"
},
"osPolicyResourceCompliances": {
"description": "Compliance data for each resource within the policy that is applied to the VM.",
"items": {
"$ref": "OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceCompliance"
},
"type": "array"
}
},
"type": "object"
},
"OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceCompliance": {
"description": "Compliance data for an OS policy resource.",
"id": "OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceCompliance",
"properties": {
"complianceState": {
"description": "The compliance state of the resource.",
"enum": [
"UNKNOWN",
"COMPLIANT",
"NON_COMPLIANT"
],
"enumDescriptions": [
"The resource is in an unknown compliance state. To get more details about why the policy is in this state, review the output of the `compliance_state_reason` field.",
"Resource is compliant.",
"Resource is non-compliant."
],
"type": "string"
},
"complianceStateReason": {
"description": "A reason for the resource to be in the given compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. The following values are supported when `compliance_state == UNKNOWN` * `execution-errors`: Errors were encountered by the agent while executing the resource and the compliance state couldn't be determined. * `execution-skipped-by-agent`: Resource execution was skipped by the agent because errors were encountered while executing prior resources in the OS policy. * `os-policy-execution-attempt-failed`: The execution of the OS policy containing this resource failed and the compliance state couldn't be determined. * `os-policy-execution-pending`: OS policy that owns this resource was assigned to the given VM, but was not executed yet.",
"type": "string"
},
"configSteps": {
"description": "Ordered list of configuration completed by the agent for the OS policy resource.",
"items": {
"$ref": "OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceOSPolicyResourceConfigStep"
},
"type": "array"
},
"execResourceOutput": {
"$ref": "OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceExecResourceOutput",
"description": "ExecResource specific output."
},
"osPolicyResourceId": {
"description": "The ID of the OS policy resource.",
"type": "string"
}
},
"type": "object"
},
"OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceExecResourceOutput": {
"description": "ExecResource specific output.",
"id": "OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceExecResourceOutput",
"properties": {
"enforcementOutput": {
"description": "Output from enforcement phase output file (if run). Output size is limited to 100K bytes.",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceOSPolicyResourceConfigStep": {
"description": "Step performed by the OS Config agent for configuring an `OSPolicy` resource to its desired state.",
"id": "OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceOSPolicyResourceConfigStep",
"properties": {
"errorMessage": {
"description": "An error message recorded during the execution of this step. Only populated if errors were encountered during this step execution.",
"type": "string"
},
"type": {
"description": "Configuration step type.",
"enum": [
"TYPE_UNSPECIFIED",
"VALIDATION",
"DESIRED_STATE_CHECK",
"DESIRED_STATE_ENFORCEMENT",
"DESIRED_STATE_CHECK_POST_ENFORCEMENT"
],
"enumDescriptions": [
"Default value. This value is unused.",
"Checks for resource conflicts such as schema errors.",
"Checks the current status of the desired state for a resource.",
"Enforces the desired state for a resource that is not in desired state.",
"Re-checks the status of the desired state. This check is done for a resource after the enforcement of all OS policies. This step is used to determine the final desired state status for the resource. It accounts for any resources that might have drifted from their desired state due to side effects from executing other resources."
],
"type": "string"
}
},
"type": "object"
},
"OSPolicyAssignmentRollout": {
"description": "Message to configure the rollout at the zonal level for the OS policy assignment.",
"id": "OSPolicyAssignmentRollout",
"properties": {
"disruptionBudget": {
"$ref": "FixedOrPercent",
"description": "Required. The maximum number (or percentage) of VMs per zone to disrupt at any given moment."
},
"minWaitDuration": {
"description": "Required. This determines the minimum duration of time to wait after the configuration changes are applied through the current rollout. A VM continues to count towards the `disruption_budget` at least until this duration of time has passed after configuration changes are applied.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"OSPolicyInventoryFilter": {
"description": "Filtering criteria to select VMs based on inventory details.",
"id": "OSPolicyInventoryFilter",
"properties": {
"osShortName": {
"description": "Required. The OS short name",
"type": "string"
},
"osVersion": {
"description": "The OS version Prefix matches are supported if asterisk(*) is provided as the last character. For example, to match all versions with a major version of `7`, specify the following value for this field `7.*` An empty string matches all OS versions.",
"type": "string"
}
},
"type": "object"
},
"OSPolicyOSFilter": {
"description": "Filtering criteria to select VMs based on OS details.",
"id": "OSPolicyOSFilter",
"properties": {
"osShortName": {
"description": "This should match OS short name emitted by the OS inventory agent. An empty value matches any OS.",
"type": "string"
},
"osVersion": {
"description": "This value should match the version emitted by the OS inventory agent. Prefix matches are supported if asterisk(*) is provided as the last character. For example, to match all versions with a major version of `7`, specify the following value for this field `7.*`",
"type": "string"
}
},
"type": "object"
},
"OSPolicyResource": {
"description": "An OS policy resource is used to define the desired state configuration and provides a specific functionality like installing/removing packages, executing a script etc. The system ensures that resources are always in their desired state by taking necessary actions if they have drifted from their desired state.",
"id": "OSPolicyResource",
"properties": {
"exec": {
"$ref": "OSPolicyResourceExecResource",
"description": "Exec resource"
},
"file": {
"$ref": "OSPolicyResourceFileResource",
"description": "File resource"
},
"id": {
"description": "Required. The id of the resource 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 OS policy.",
"type": "string"
},
"pkg": {
"$ref": "OSPolicyResourcePackageResource",
"description": "Package resource"
},
"repository": {
"$ref": "OSPolicyResourceRepositoryResource",
"description": "Package repository resource"
}
},
"type": "object"
},
"OSPolicyResourceCompliance": {
"deprecated": true,
"description": "Compliance data for an OS policy resource.",
"id": "OSPolicyResourceCompliance",
"properties": {
"configSteps": {
"description": "Ordered list of configuration steps taken by the agent for the OS policy resource.",
"items": {
"$ref": "OSPolicyResourceConfigStep"
},
"type": "array"
},
"execResourceOutput": {
"$ref": "OSPolicyResourceComplianceExecResourceOutput",
"description": "ExecResource specific output."
},
"osPolicyResourceId": {
"description": "The id of the OS policy resource.",
"type": "string"
},
"state": {
"description": "Compliance state of the OS policy resource.",
"enum": [
"OS_POLICY_COMPLIANCE_STATE_UNSPECIFIED",
"COMPLIANT",
"NON_COMPLIANT",
"UNKNOWN",
"NO_OS_POLICIES_APPLICABLE"
],
"enumDescriptions": [
"Default value. This value is unused.",
"Compliant state.",
"Non-compliant state",
"Unknown compliance state.",
"No applicable OS policies were found for the instance. This state is only applicable to the instance."
],
"type": "string"
}
},
"type": "object"
},
"OSPolicyResourceComplianceExecResourceOutput": {
"deprecated": true,
"description": "ExecResource specific output.",
"id": "OSPolicyResourceComplianceExecResourceOutput",
"properties": {
"enforcementOutput": {
"description": "Output from Enforcement phase output file (if run). Output size is limited to 100K bytes.",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"OSPolicyResourceConfigStep": {
"deprecated": true,
"description": "Step performed by the OS Config agent for configuring an `OSPolicyResource` to its desired state.",
"id": "OSPolicyResourceConfigStep",
"properties": {
"errorMessage": {
"description": "An error message recorded during the execution of this step. Only populated when outcome is FAILED.",
"type": "string"
},
"outcome": {
"description": "Outcome of the configuration step.",
"enum": [
"OUTCOME_UNSPECIFIED",
"SUCCEEDED",
"FAILED"
],
"enumDescriptions": [
"Default value. This value is unused.",
"The step succeeded.",
"The step failed."
],
"type": "string"
},
"type": {
"description": "Configuration step type.",
"enum": [
"TYPE_UNSPECIFIED",
"VALIDATION",
"DESIRED_STATE_CHECK",
"DESIRED_STATE_ENFORCEMENT",
"DESIRED_STATE_CHECK_POST_ENFORCEMENT"
],
"enumDescriptions": [
"Default value. This value is unused.",
"Validation to detect resource conflicts, schema errors, etc.",
"Check the current desired state status of the resource.",
"Enforce the desired state for a resource that is not in desired state.",
"Re-check desired state status for a resource after enforcement of all resources in the current configuration run. This step is used to determine the final desired state status for the resource. It accounts for any resources that might have drifted from their desired state due to side effects from configuring other resources during the current configuration run."
],
"type": "string"
}
},
"type": "object"
},
"OSPolicyResourceExecResource": {
"description": "A resource that allows executing scripts on the VM. The `ExecResource` has 2 stages: `validate` and `enforce` and both stages accept a script as an argument to execute. When the `ExecResource` is applied by the agent, it first executes the script in the `validate` stage. The `validate` stage can signal that the `ExecResource` is already in the desired state by returning an exit code of `100`. If the `ExecResource` is not in the desired state, it should return an exit code of `101`. Any other exit code returned by this stage is considered an error. If the `ExecResource` is not in the desired state based on the exit code from the `validate` stage, the agent proceeds to execute the script from the `enforce` stage. If the `ExecResource` is already in the desired state, the `enforce` stage will not be run. Similar to `validate` stage, the `enforce` stage should return an exit code of `100` to indicate that the resource in now in its desired state. Any other exit code is considered an error. NOTE: An exit code of `100` was chosen over `0` (and `101` vs `1`) to have an explicit indicator of `in desired state`, `not in desired state` and errors. Because, for example, Powershell will always return an exit code of `0` unless an `exit` statement is provided in the script. So, for reasons of consistency and being explicit, exit codes `100` and `101` were chosen.",
"id": "OSPolicyResourceExecResource",
"properties": {
"enforce": {
"$ref": "OSPolicyResourceExecResourceExec",
"description": "What to run to bring this resource into the desired state. An exit code of 100 indicates \"success\", any other exit code indicates a failure running enforce."
},
"validate": {
"$ref": "OSPolicyResourceExecResourceExec",
"description": "Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates \"in desired state\", and exit code of 101 indicates \"not in desired state\". Any other exit code indicates a failure running validate."
}
},
"type": "object"
},
"OSPolicyResourceExecResourceExec": {
"description": "A file or script to execute.",
"id": "OSPolicyResourceExecResourceExec",
"properties": {
"args": {
"description": "Optional arguments to pass to the source during execution.",
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"$ref": "OSPolicyResourceFile",
"description": "A remote or local file."
},
"interpreter": {
"description": "Required. The script interpreter to use.",
"enum": [
"INTERPRETER_UNSPECIFIED",
"NONE",
"SHELL",
"POWERSHELL"
],
"enumDescriptions": [
"Invalid value, the request will return validation error.",
"If an interpreter is not specified, the source is executed directly. This execution, without an interpreter, only succeeds for executables and scripts that have shebang lines.",
"Indicates that the script runs with `/bin/sh` on Linux and `cmd.exe` on Windows.",
"Indicates that the script runs with PowerShell."
],
"type": "string"
},
"outputFilePath": {
"description": "Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes.",
"type": "string"
},
"script": {
"description": "An inline script. The size of the script is limited to 32KiB.",
"type": "string"
}
},
"type": "object"
},
"OSPolicyResourceFile": {
"description": "A remote or local file.",
"id": "OSPolicyResourceFile",
"properties": {
"allowInsecure": {
"description": "Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified.",
"type": "boolean"
},
"gcs": {
"$ref": "OSPolicyResourceFileGcs",
"description": "A Cloud Storage object."
},
"localPath": {
"description": "A local path within the VM to use.",
"type": "string"
},
"remote": {
"$ref": "OSPolicyResourceFileRemote",
"description": "A generic remote file."
}
},
"type": "object"
},
"OSPolicyResourceFileGcs": {
"description": "Specifies a file available as a Cloud Storage Object.",
"id": "OSPolicyResourceFileGcs",
"properties": {
"bucket": {
"description": "Required. Bucket of the Cloud Storage object.",
"type": "string"
},
"generation": {
"description": "Generation number of the Cloud Storage object.",
"format": "int64",
"type": "string"
},
"object": {
"description": "Required. Name of the Cloud Storage object.",
"type": "string"
}
},
"type": "object"
},
"OSPolicyResourceFileRemote": {
"description": "Specifies a file available via some URI.",
"id": "OSPolicyResourceFileRemote",
"properties": {
"sha256Checksum": {
"description": "SHA256 checksum of the remote file.",
"type": "string"
},
"uri": {
"description": "Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`.",
"type": "string"
}
},
"type": "object"
},
"OSPolicyResourceFileResource": {
"description": "A resource that manages the state of a file.",
"id": "OSPolicyResourceFileResource",
"properties": {
"content": {
"description": "A a file with this content. The size of the content is limited to 32KiB.",
"type": "string"
},
"file": {
"$ref": "OSPolicyResourceFile",
"description": "A remote or local source."
},
"path": {
"description": "Required. The absolute path of the file within the VM.",
"type": "string"
},
"permissions": {
"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",
"type": "string"
},
"state": {
"description": "Required. Desired state of the file.",
"enum": [
"DESIRED_STATE_UNSPECIFIED",
"PRESENT",
"ABSENT",
"CONTENTS_MATCH"
],
"enumDescriptions": [
"Unspecified is invalid.",
"Ensure file at path is present.",
"Ensure file at path is absent.",
"Ensure the contents of the file at path matches. If the file does not exist it will be created."
],
"type": "string"
}
},
"type": "object"
},
"OSPolicyResourceGroup": {
"description": "Resource groups provide a mechanism to group OS policy resources. Resource groups enable OS policy authors to create a single OS policy to be applied to VMs running different operating Systems. When the OS policy is applied to a target VM, the appropriate resource group within the OS policy is selected based on the `OSFilter` specified within the resource group.",
"id": "OSPolicyResourceGroup",
"properties": {
"inventoryFilters": {
"description": "List of inventory filters for the resource group. The resources in this resource group are applied to the target VM if it satisfies at least one of the following inventory filters. For example, to apply this resource group to VMs running either `RHEL` or `CentOS` operating systems, specify 2 items for the list with following values: inventory_filters[0].os_short_name='rhel' and inventory_filters[1].os_short_name='centos' If the list is empty, this resource group will be applied to the target VM unconditionally.",
"items": {
"$ref": "OSPolicyInventoryFilter"
},
"type": "array"
},
"osFilter": {
"$ref": "OSPolicyOSFilter",
"deprecated": true,
"description": "Deprecated. Use the `inventory_filters` field instead. Used to specify the OS filter for a resource group"
},
"resources": {
"description": "Required. List of resources configured for this resource group. The resources are executed in the exact order specified here.",
"items": {
"$ref": "OSPolicyResource"
},
"type": "array"
}
},
"type": "object"
},
"OSPolicyResourcePackageResource": {
"description": "A resource that manages a system package.",
"id": "OSPolicyResourcePackageResource",
"properties": {
"apt": {
"$ref": "OSPolicyResourcePackageResourceAPT",
"description": "A package managed by Apt."
},
"deb": {
"$ref": "OSPolicyResourcePackageResourceDeb",
"description": "A deb package file."
},
"desiredState": {
"description": "Required. The desired state the agent should maintain for this package.",
"enum": [
"DESIRED_STATE_UNSPECIFIED",
"INSTALLED",
"REMOVED"
],
"enumDescriptions": [
"Unspecified is invalid.",
"Ensure that the package is installed.",
"The agent ensures that the package is not installed and uninstalls it if detected."
],
"type": "string"
},
"googet": {
"$ref": "OSPolicyResourcePackageResourceGooGet",
"description": "A package managed by GooGet."
},
"msi": {
"$ref": "OSPolicyResourcePackageResourceMSI",
"description": "An MSI package."
},
"rpm": {
"$ref": "OSPolicyResourcePackageResourceRPM",
"description": "An rpm package file."
},
"yum": {
"$ref": "OSPolicyResourcePackageResourceYUM",
"description": "A package managed by YUM."
},
"zypper": {
"$ref": "OSPolicyResourcePackageResourceZypper",
"description": "A package managed by Zypper."
}
},
"type": "object"
},
"OSPolicyResourcePackageResourceAPT": {
"description": "A package managed by APT. - install: `apt-get update && apt-get -y install [name]` - remove: `apt-get -y remove [name]`",
"id": "OSPolicyResourcePackageResourceAPT",
"properties": {
"name": {
"description": "Required. Package name.",
"type": "string"
}
},
"type": "object"
},
"OSPolicyResourcePackageResourceDeb": {
"description": "A deb package file. dpkg packages only support INSTALLED state.",
"id": "OSPolicyResourcePackageResourceDeb",
"properties": {
"pullDeps": {
"description": "Whether dependencies should also be installed. - install when false: `dpkg -i package` - install when true: `apt-get update && apt-get -y install package.deb`",
"type": "boolean"
},
"source": {
"$ref": "OSPolicyResourceFile",
"description": "Required. A deb package."
}
},
"type": "object"
},
"OSPolicyResourcePackageResourceGooGet": {
"description": "A package managed by GooGet. - install: `googet -noconfirm install package` - remove: `googet -noconfirm remove package`",
"id": "OSPolicyResourcePackageResourceGooGet",
"properties": {
"name": {
"description": "Required. Package name.",
"type": "string"
}
},
"type": "object"
},
"OSPolicyResourcePackageResourceMSI": {
"description": "An MSI package. MSI packages only support INSTALLED state.",
"id": "OSPolicyResourcePackageResourceMSI",
"properties": {
"properties": {
"description": "Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of `ACTION=INSTALL REBOOT=ReallySuppress`.",
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"$ref": "OSPolicyResourceFile",
"description": "Required. The MSI package."
}
},
"type": "object"
},
"OSPolicyResourcePackageResourceRPM": {
"description": "An RPM package file. RPM packages only support INSTALLED state.",
"id": "OSPolicyResourcePackageResourceRPM",
"properties": {
"pullDeps": {
"description": "Whether dependencies should also be installed. - install when false: `rpm --upgrade --replacepkgs package.rpm` - install when true: `yum -y install package.rpm` or `zypper -y install package.rpm`",
"type": "boolean"
},
"source": {
"$ref": "OSPolicyResourceFile",
"description": "Required. An rpm package."
}
},
"type": "object"
},
"OSPolicyResourcePackageResourceYUM": {
"description": "A package managed by YUM. - install: `yum -y install package` - remove: `yum -y remove package`",
"id": "OSPolicyResourcePackageResourceYUM",
"properties": {
"name": {
"description": "Required. Package name.",
"type": "string"
}
},
"type": "object"
},
"OSPolicyResourcePackageResourceZypper": {
"description": "A package managed by Zypper. - install: `zypper -y install package` - remove: `zypper -y rm package`",
"id": "OSPolicyResourcePackageResourceZypper",
"properties": {
"name": {
"description": "Required. Package name.",
"type": "string"
}
},
"type": "object"
},
"OSPolicyResourceRepositoryResource": {
"description": "A resource that manages a package repository.",
"id": "OSPolicyResourceRepositoryResource",
"properties": {
"apt": {
"$ref": "OSPolicyResourceRepositoryResourceAptRepository",
"description": "An Apt Repository."
},
"goo": {
"$ref": "OSPolicyResourceRepositoryResourceGooRepository",
"description": "A Goo Repository."
},
"yum": {
"$ref": "OSPolicyResourceRepositoryResourceYumRepository",
"description": "A Yum Repository."
},
"zypper": {
"$ref": "OSPolicyResourceRepositoryResourceZypperRepository",
"description": "A Zypper Repository."
}
},
"type": "object"
},
"OSPolicyResourceRepositoryResourceAptRepository": {
"description": "Represents a single apt package repository. These will be added to a repo file that will be managed at `/etc/apt/sources.list.d/google_osconfig.list`.",
"id": "OSPolicyResourceRepositoryResourceAptRepository",
"properties": {
"archiveType": {
"description": "Required. Type of archive files in this repository.",
"enum": [
"ARCHIVE_TYPE_UNSPECIFIED",
"DEB",
"DEB_SRC"
],
"enumDescriptions": [
"Unspecified is invalid.",
"Deb indicates that the archive contains binary files.",
"Deb-src indicates that the archive contains source files."
],
"type": "string"
},
"components": {
"description": "Required. List of components for this repository. Must contain at least one item.",
"items": {
"type": "string"
},
"type": "array"
},
"distribution": {
"description": "Required. Distribution of this repository.",
"type": "string"
},
"gpgKey": {
"description": "URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg`.",
"type": "string"
},
"uri": {
"description": "Required. URI for this repository.",
"type": "string"
}
},
"type": "object"
},
"OSPolicyResourceRepositoryResourceGooRepository": {
"description": "Represents a Goo package repository. These are added to a repo file that is managed at `C:/ProgramData/GooGet/repos/google_osconfig.repo`.",
"id": "OSPolicyResourceRepositoryResourceGooRepository",
"properties": {
"name": {
"description": "Required. The name of the repository.",
"type": "string"
},
"url": {
"description": "Required. The url of the repository.",
"type": "string"
}
},
"type": "object"
},
"OSPolicyResourceRepositoryResourceYumRepository": {
"description": "Represents a single yum package repository. These are added to a repo file that is managed at `/etc/yum.repos.d/google_osconfig.repo`.",
"id": "OSPolicyResourceRepositoryResourceYumRepository",
"properties": {
"baseUrl": {
"description": "Required. The location of the repository directory.",
"type": "string"
},
"displayName": {
"description": "The display name of the repository.",
"type": "string"
},
"gpgKeys": {
"description": "URIs of GPG keys.",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"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 resource conflicts.",
"type": "string"
}
},
"type": "object"
},
"OSPolicyResourceRepositoryResourceZypperRepository": {
"description": "Represents a single zypper package repository. These are added to a repo file that is managed at `/etc/zypp/repos.d/google_osconfig.repo`.",
"id": "OSPolicyResourceRepositoryResourceZypperRepository",
"properties": {
"baseUrl": {
"description": "Required. The location of the repository directory.",
"type": "string"
},
"displayName": {
"description": "The display name of the repository.",
"type": "string"
},
"gpgKeys": {
"description": "URIs of GPG keys.",
"items": {
"type": "string"
},
"type": "array"
},
"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 GuestPolicy conflicts.",
"type": "string"
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "Operation",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
"type": "boolean"
},
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
"type": "object"
}
},
"type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"StatusProto": {
"description": "Wire-format for a Status object",
"id": "StatusProto",
"properties": {
"canonicalCode": {
"description": "copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6;",
"format": "int32",
"type": "integer"
},
"code": {
"description": "Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1;",
"format": "int32",
"type": "integer"
},
"message": {
"description": "Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3;",
"type": "string"
},
"messageSet": {
"$ref": "MessageSet",
"description": "message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5;"
},
"space": {
"description": "copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs",
"type": "string"
}
},
"type": "object"
},
"VulnerabilityReport": {
"description": "This API resource represents the vulnerability report for a specified Compute Engine virtual machine (VM) instance at a given point in time. For more information, see [Vulnerability reports](https://cloud.google.com/compute/docs/instances/os-inventory-management#vulnerability-reports).",
"id": "VulnerabilityReport",
"properties": {
"highestUpgradableCveSeverity": {
"description": "Output only. Highest level of severity among all the upgradable vulnerabilities with CVEs attached.",
"enum": [
"VULNERABILITY_SEVERITY_LEVEL_UNSPECIFIED",
"NONE",
"MINIMAL",
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
],
"enumDescriptions": [
"Default SeverityLevel. This value is unused.",
"Vulnerability has no severity level.",
"Vulnerability severity level is minimal. This is level below the low severity level.",
"Vulnerability severity level is low. This is level below the medium severity level.",
"Vulnerability severity level is medium. This is level below the high severity level.",
"Vulnerability severity level is high. This is level below the critical severity level.",
"Vulnerability severity level is critical. This is the highest severity level."
],
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The `vulnerabilityReport` API resource name. Format: `projects/{project_number}/locations/{location}/instances/{instance_id}/vulnerabilityReport`",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The timestamp for when the last vulnerability report was generated for the VM.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"vulnerabilities": {
"description": "Output only. List of vulnerabilities affecting the VM.",
"items": {
"$ref": "VulnerabilityReportVulnerability"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"VulnerabilityReportVulnerability": {
"description": "A vulnerability affecting the VM instance.",
"id": "VulnerabilityReportVulnerability",
"properties": {
"availableInventoryItemIds": {
"deprecated": true,
"description": "Corresponds to the `AVAILABLE_PACKAGE` inventory item on the VM. If the vulnerability report was not updated after the VM inventory update, these values might not display in VM inventory. If there is no available fix, the field is empty. The `inventory_item` value specifies the latest `SoftwarePackage` available to the VM that fixes the vulnerability.",
"items": {
"type": "string"
},
"type": "array"
},
"createTime": {
"description": "The timestamp for when the vulnerability was first detected.",
"format": "google-datetime",
"type": "string"
},
"details": {
"$ref": "VulnerabilityReportVulnerabilityDetails",
"description": "Contains metadata as per the upstream feed of the operating system and NVD."
},
"installedInventoryItemIds": {
"deprecated": true,
"description": "Corresponds to the `INSTALLED_PACKAGE` inventory item on the VM. This field displays the inventory items affected by this vulnerability. If the vulnerability report was not updated after the VM inventory update, these values might not display in VM inventory. For some distros, this field may be empty.",
"items": {
"type": "string"
},
"type": "array"
},
"items": {
"description": "List of items affected by the vulnerability.",
"items": {
"$ref": "VulnerabilityReportVulnerabilityItem"
},
"type": "array"
},
"updateTime": {
"description": "The timestamp for when the vulnerability was last modified.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"VulnerabilityReportVulnerabilityDetails": {
"description": "Contains metadata information for the vulnerability. This information is collected from the upstream feed of the operating system.",
"id": "VulnerabilityReportVulnerabilityDetails",
"properties": {
"cve": {
"description": "The CVE of the vulnerability. CVE cannot be empty and the combination of should be unique across vulnerabilities for a VM.",
"type": "string"
},
"cvssV2Score": {
"description": "The CVSS V2 score of this vulnerability. CVSS V2 score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.",
"format": "float",
"type": "number"
},
"cvssV3": {
"$ref": "CVSSv3",
"description": "The full description of the CVSSv3 for this vulnerability from NVD."
},
"description": {
"description": "The note or description describing the vulnerability from the distro.",
"type": "string"
},
"references": {
"description": "Corresponds to the references attached to the `VulnerabilityDetails`.",
"items": {
"$ref": "VulnerabilityReportVulnerabilityDetailsReference"
},
"type": "array"
},
"severity": {
"description": "Assigned severity/impact ranking from the distro.",
"type": "string"
}
},
"type": "object"
},
"VulnerabilityReportVulnerabilityDetailsReference": {
"description": "A reference for this vulnerability.",
"id": "VulnerabilityReportVulnerabilityDetailsReference",
"properties": {
"source": {
"description": "The source of the reference e.g. NVD.",
"type": "string"
},
"url": {
"description": "The url of the reference.",
"type": "string"
}
},
"type": "object"
},
"VulnerabilityReportVulnerabilityItem": {
"description": "OS inventory item that is affected by a vulnerability or fixed as a result of a vulnerability.",
"id": "VulnerabilityReportVulnerabilityItem",
"properties": {
"availableInventoryItemId": {
"description": "Corresponds to the `AVAILABLE_PACKAGE` inventory item on the VM. If the vulnerability report was not updated after the VM inventory update, these values might not display in VM inventory. If there is no available fix, the field is empty. The `inventory_item` value specifies the latest `SoftwarePackage` available to the VM that fixes the vulnerability.",
"type": "string"
},
"fixedCpeUri": {
"description": "The recommended [CPE URI](https://cpe.mitre.org/specification/) update that contains a fix for this vulnerability.",
"type": "string"
},
"installedInventoryItemId": {
"description": "Corresponds to the `INSTALLED_PACKAGE` inventory item on the VM. This field displays the inventory items affected by this vulnerability. If the vulnerability report was not updated after the VM inventory update, these values might not display in VM inventory. For some operating systems, this field might be empty.",
"type": "string"
},
"upstreamFix": {
"description": "The upstream OS patch, packages or KB that fixes the vulnerability.",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "OS Config API",
"version": "v1alpha",
"version_module": true
}