From c541143744c4b077d0a044455a35d0de227a0bf6 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 27 May 2021 07:25:51 +0000 Subject: [PATCH] feat(osconfig): update the api #### osconfig:v1alpha The following keys were added: - schemas.OSPolicyResourceCompliance.properties.execResourceOutput.$ref (Total Keys: 1) - schemas.OSPolicyResourceComplianceExecResourceOutput (Total Keys: 4) - schemas.OSPolicyResourceExecResourceExec.properties.outputFilePath.type (Total Keys: 1) --- ...cations.instanceOSPoliciesCompliances.html | 10 +- ...jects.locations.instances.inventories.html | 4 +- ...ations.instances.vulnerabilityReports.html | 4 +- ...rojects.locations.osPolicyAssignments.html | 122 ++++++++++-------- .../documents/osconfig.v1.json | 2 +- .../documents/osconfig.v1alpha.json | 54 +++++--- .../documents/osconfig.v1beta.json | 2 +- 7 files changed, 117 insertions(+), 81 deletions(-) diff --git a/docs/dyn/osconfig_v1alpha.projects.locations.instanceOSPoliciesCompliances.html b/docs/dyn/osconfig_v1alpha.projects.locations.instanceOSPoliciesCompliances.html index d53feb920e6..879c01af3d0 100644 --- a/docs/dyn/osconfig_v1alpha.projects.locations.instanceOSPoliciesCompliances.html +++ b/docs/dyn/osconfig_v1alpha.projects.locations.instanceOSPoliciesCompliances.html @@ -106,7 +106,7 @@

Method Details

Returns: An object of the form: - { # 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](/compute/docs/os-configuration-management/view-compliance). + { # 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). "detailedState": "A String", # 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. "detailedStateReason": "A String", # Output only. The reason for the `detailed_state` of the VM (if any). "instance": "A String", # Output only. The Compute Engine VM instance name. @@ -125,6 +125,9 @@

Method Details

"type": "A String", # Configuration step type. }, ], + "execResourceOutput": { # ExecResource specific output. # ExecResource specific output. + "enforcementOutput": "A String", # Output from Enforcement phase output file (if run). Output size is limited to 100K bytes. + }, "osPolicyResourceId": "A String", # The id of the OS policy resource. "state": "A String", # Compliance state of the OS policy resource. }, @@ -155,7 +158,7 @@

Method Details

{ # A response message for listing OS policies compliance data for all Compute Engine VMs in the given location. "instanceOsPoliciesCompliances": [ # List of instance OS policies compliance objects. - { # 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](/compute/docs/os-configuration-management/view-compliance). + { # 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). "detailedState": "A String", # 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. "detailedStateReason": "A String", # Output only. The reason for the `detailed_state` of the VM (if any). "instance": "A String", # Output only. The Compute Engine VM instance name. @@ -174,6 +177,9 @@

Method Details

"type": "A String", # Configuration step type. }, ], + "execResourceOutput": { # ExecResource specific output. # ExecResource specific output. + "enforcementOutput": "A String", # Output from Enforcement phase output file (if run). Output size is limited to 100K bytes. + }, "osPolicyResourceId": "A String", # The id of the OS policy resource. "state": "A String", # Compliance state of the OS policy resource. }, diff --git a/docs/dyn/osconfig_v1alpha.projects.locations.instances.inventories.html b/docs/dyn/osconfig_v1alpha.projects.locations.instances.inventories.html index 8a359f2dc86..19398dfa40a 100644 --- a/docs/dyn/osconfig_v1alpha.projects.locations.instances.inventories.html +++ b/docs/dyn/osconfig_v1alpha.projects.locations.instances.inventories.html @@ -111,7 +111,7 @@

Method Details

Returns: An object of the form: - { # 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](/compute/docs/instances/os-inventory-management#data-collected). + { # 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). "items": { # 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. "a_key": { # A single piece of inventory on a VM. "availablePackage": { # Software package information of the operating system. # Software package available to be installed on the VM instance. @@ -278,7 +278,7 @@

Method Details

{ # A response message for listing inventory data for all VMs in a specified location. "inventories": [ # List of inventory objects. - { # 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](/compute/docs/instances/os-inventory-management#data-collected). + { # 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). "items": { # 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. "a_key": { # A single piece of inventory on a VM. "availablePackage": { # Software package information of the operating system. # Software package available to be installed on the VM instance. diff --git a/docs/dyn/osconfig_v1alpha.projects.locations.instances.vulnerabilityReports.html b/docs/dyn/osconfig_v1alpha.projects.locations.instances.vulnerabilityReports.html index e2a38660d0d..2547a77654f 100644 --- a/docs/dyn/osconfig_v1alpha.projects.locations.instances.vulnerabilityReports.html +++ b/docs/dyn/osconfig_v1alpha.projects.locations.instances.vulnerabilityReports.html @@ -106,7 +106,7 @@

Method Details

Returns: An object of the form: - { # 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](/compute/docs/instances/os-inventory-management#vulnerability-reports). + { # 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). "name": "A String", # Output only. The `vulnerabilityReport` API resource name. Format: `projects/{project_number}/locations/{location}/instances/{instance_id}/vulnerabilityReport` "updateTime": "A String", # Output only. The timestamp for when the last vulnerability report was generated for the VM. "vulnerabilities": [ # Output only. List of vulnerabilities affecting the VM. @@ -168,7 +168,7 @@

Method Details

{ # A response message for listing vulnerability reports for all VM instances in the specified location. "nextPageToken": "A String", # The pagination token to retrieve the next page of vulnerabilityReports object. "vulnerabilityReports": [ # List of vulnerabilityReport objects. - { # 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](/compute/docs/instances/os-inventory-management#vulnerability-reports). + { # 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). "name": "A String", # Output only. The `vulnerabilityReport` API resource name. Format: `projects/{project_number}/locations/{location}/instances/{instance_id}/vulnerabilityReport` "updateTime": "A String", # Output only. The timestamp for when the last vulnerability report was generated for the VM. "vulnerabilities": [ # Output only. List of vulnerabilities affecting the VM. diff --git a/docs/dyn/osconfig_v1alpha.projects.locations.osPolicyAssignments.html b/docs/dyn/osconfig_v1alpha.projects.locations.osPolicyAssignments.html index 2c24de6ad88..b5091cd0e60 100644 --- a/docs/dyn/osconfig_v1alpha.projects.locations.osPolicyAssignments.html +++ b/docs/dyn/osconfig_v1alpha.projects.locations.osPolicyAssignments.html @@ -84,10 +84,10 @@

Instance Methods

Close httplib2 connections.

create(parent, body=None, osPolicyAssignmentId=None, x__xgafv=None)

-

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](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).

+

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

delete(name, x__xgafv=None)

-

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](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).

+

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

get(name, x__xgafv=None)

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.

@@ -105,7 +105,7 @@

Instance Methods

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

-

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](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).

+

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

Method Details

close() @@ -114,14 +114,14 @@

Method Details

create(parent, body=None, osPolicyAssignmentId=None, x__xgafv=None) -
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](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
+  
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).
 
 Args:
   parent: string, Required. The parent resource name in the form: projects/{project}/locations/{location} (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # 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](/compute/docs/os-configuration-management/working-with-os-policies).
+{ # 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).
   "baseline": True or False, # 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.
   "deleted": True or False, # Output only. Indicates that this revision deletes the OS policy assignment.
   "description": "A String", # OS policy assignment description. Length of the description is limited to 1024 characters.
@@ -179,6 +179,7 @@ 

Method Details

}, }, "interpreter": "A String", # Required. The script interpreter to use. + "outputFilePath": "A String", # 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. "script": "A String", # An inline script. The size of the script is limited to 1024 characters. }, "validate": { # A file or script to execute. # 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. @@ -199,6 +200,7 @@

Method Details

}, }, "interpreter": "A String", # Required. The script interpreter to use. + "outputFilePath": "A String", # 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. "script": "A String", # An inline script. The size of the script is limited to 1024 characters. }, }, @@ -223,11 +225,11 @@

Method Details

}, "id": "A String", # 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. "pkg": { # A resource that manages a system package. # Package resource - "apt": { # A package managed by APT. install: `apt-get update && apt-get -y install [name]` remove: `apt-get -y remove [name]` # A package managed by Apt. + "apt": { # A package managed by APT. - install: `apt-get update && apt-get -y install [name]` - remove: `apt-get -y remove [name]` # A package managed by Apt. "name": "A String", # Required. Package name. }, "deb": { # A deb package file. dpkg packages only support INSTALLED state. # A deb package file. - "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `dpkg -i package` install when true: `apt-get update && apt-get -y install package.deb` + "pullDeps": True or False, # Whether dependencies should also be installed. - install when false: `dpkg -i package` - install when true: `apt-get update && apt-get -y install package.deb` "source": { # A remote or local file. # Required. A deb package. "allowInsecure": True or False, # 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. "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. @@ -243,11 +245,11 @@

Method Details

}, }, "desiredState": "A String", # Required. The desired state the agent should maintain for this package. - "googet": { # A package managed by GooGet. install: `googet -noconfirm install package` remove: `googet -noconfirm remove package` # A package managed by GooGet. + "googet": { # A package managed by GooGet. - install: `googet -noconfirm install package` - remove: `googet -noconfirm remove package` # A package managed by GooGet. "name": "A String", # Required. Package name. }, "msi": { # An MSI package. MSI packages only support INSTALLED state. # An MSI package. - "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of "ACTION=INSTALL REBOOT=ReallySuppress". + "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of `ACTION=INSTALL REBOOT=ReallySuppress`. "A String", ], "source": { # A remote or local file. # Required. The MSI package. @@ -265,7 +267,7 @@

Method Details

}, }, "rpm": { # An RPM package file. RPM packages only support INSTALLED state. # An rpm package file. - "pullDeps": True or False, # 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` + "pullDeps": True or False, # 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` "source": { # A remote or local file. # Required. An rpm package. "allowInsecure": True or False, # 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. "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. @@ -280,21 +282,21 @@

Method Details

}, }, }, - "yum": { # A package managed by YUM. install: `yum -y install package` remove: `yum -y remove package` # A package managed by YUM. + "yum": { # A package managed by YUM. - install: `yum -y install package` - remove: `yum -y remove package` # A package managed by YUM. "name": "A String", # Required. Package name. }, - "zypper": { # A package managed by Zypper. install: `zypper -y install package` remove: `zypper -y rm package` # A package managed by Zypper. + "zypper": { # A package managed by Zypper. - install: `zypper -y install package` - remove: `zypper -y rm package` # A package managed by Zypper. "name": "A String", # Required. Package name. }, }, "repository": { # A resource that manages a package repository. # Package repository resource - "apt": { # 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. # An Apt Repository. + "apt": { # 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`. # An Apt Repository. "archiveType": "A String", # Required. Type of archive files in this repository. "components": [ # Required. List of components for this repository. Must contain at least one item. "A String", ], "distribution": "A String", # Required. Distribution of this repository. - "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at /etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg. + "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg`. "uri": "A String", # Required. URI for this repository. }, "goo": { # Represents a Goo package repository. These are added to a repo file that is managed at `C:/ProgramData/GooGet/repos/google_osconfig.repo`. # A Goo Repository. @@ -370,7 +372,7 @@

Method Details

delete(name, x__xgafv=None) -
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](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
+  
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).
 
 Args:
   name: string, Required. The name of the OS policy assignment to be deleted (required)
@@ -417,7 +419,7 @@ 

Method Details

Returns: An object of the form: - { # 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](/compute/docs/os-configuration-management/working-with-os-policies). + { # 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). "baseline": True or False, # 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. "deleted": True or False, # Output only. Indicates that this revision deletes the OS policy assignment. "description": "A String", # OS policy assignment description. Length of the description is limited to 1024 characters. @@ -475,6 +477,7 @@

Method Details

}, }, "interpreter": "A String", # Required. The script interpreter to use. + "outputFilePath": "A String", # 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. "script": "A String", # An inline script. The size of the script is limited to 1024 characters. }, "validate": { # A file or script to execute. # 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. @@ -495,6 +498,7 @@

Method Details

}, }, "interpreter": "A String", # Required. The script interpreter to use. + "outputFilePath": "A String", # 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. "script": "A String", # An inline script. The size of the script is limited to 1024 characters. }, }, @@ -519,11 +523,11 @@

Method Details

}, "id": "A String", # 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. "pkg": { # A resource that manages a system package. # Package resource - "apt": { # A package managed by APT. install: `apt-get update && apt-get -y install [name]` remove: `apt-get -y remove [name]` # A package managed by Apt. + "apt": { # A package managed by APT. - install: `apt-get update && apt-get -y install [name]` - remove: `apt-get -y remove [name]` # A package managed by Apt. "name": "A String", # Required. Package name. }, "deb": { # A deb package file. dpkg packages only support INSTALLED state. # A deb package file. - "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `dpkg -i package` install when true: `apt-get update && apt-get -y install package.deb` + "pullDeps": True or False, # Whether dependencies should also be installed. - install when false: `dpkg -i package` - install when true: `apt-get update && apt-get -y install package.deb` "source": { # A remote or local file. # Required. A deb package. "allowInsecure": True or False, # 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. "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. @@ -539,11 +543,11 @@

Method Details

}, }, "desiredState": "A String", # Required. The desired state the agent should maintain for this package. - "googet": { # A package managed by GooGet. install: `googet -noconfirm install package` remove: `googet -noconfirm remove package` # A package managed by GooGet. + "googet": { # A package managed by GooGet. - install: `googet -noconfirm install package` - remove: `googet -noconfirm remove package` # A package managed by GooGet. "name": "A String", # Required. Package name. }, "msi": { # An MSI package. MSI packages only support INSTALLED state. # An MSI package. - "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of "ACTION=INSTALL REBOOT=ReallySuppress". + "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of `ACTION=INSTALL REBOOT=ReallySuppress`. "A String", ], "source": { # A remote or local file. # Required. The MSI package. @@ -561,7 +565,7 @@

Method Details

}, }, "rpm": { # An RPM package file. RPM packages only support INSTALLED state. # An rpm package file. - "pullDeps": True or False, # 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` + "pullDeps": True or False, # 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` "source": { # A remote or local file. # Required. An rpm package. "allowInsecure": True or False, # 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. "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. @@ -576,21 +580,21 @@

Method Details

}, }, }, - "yum": { # A package managed by YUM. install: `yum -y install package` remove: `yum -y remove package` # A package managed by YUM. + "yum": { # A package managed by YUM. - install: `yum -y install package` - remove: `yum -y remove package` # A package managed by YUM. "name": "A String", # Required. Package name. }, - "zypper": { # A package managed by Zypper. install: `zypper -y install package` remove: `zypper -y rm package` # A package managed by Zypper. + "zypper": { # A package managed by Zypper. - install: `zypper -y install package` - remove: `zypper -y rm package` # A package managed by Zypper. "name": "A String", # Required. Package name. }, }, "repository": { # A resource that manages a package repository. # Package repository resource - "apt": { # 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. # An Apt Repository. + "apt": { # 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`. # An Apt Repository. "archiveType": "A String", # Required. Type of archive files in this repository. "components": [ # Required. List of components for this repository. Must contain at least one item. "A String", ], "distribution": "A String", # Required. Distribution of this repository. - "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at /etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg. + "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg`. "uri": "A String", # Required. URI for this repository. }, "goo": { # Represents a Goo package repository. These are added to a repo file that is managed at `C:/ProgramData/GooGet/repos/google_osconfig.repo`. # A Goo Repository. @@ -654,7 +658,7 @@

Method Details

{ # A response message for listing all assignments under given parent. "nextPageToken": "A String", # The pagination token to retrieve the next page of OS policy assignments. "osPolicyAssignments": [ # The list of assignments - { # 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](/compute/docs/os-configuration-management/working-with-os-policies). + { # 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). "baseline": True or False, # 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. "deleted": True or False, # Output only. Indicates that this revision deletes the OS policy assignment. "description": "A String", # OS policy assignment description. Length of the description is limited to 1024 characters. @@ -712,6 +716,7 @@

Method Details

}, }, "interpreter": "A String", # Required. The script interpreter to use. + "outputFilePath": "A String", # 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. "script": "A String", # An inline script. The size of the script is limited to 1024 characters. }, "validate": { # A file or script to execute. # 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. @@ -732,6 +737,7 @@

Method Details

}, }, "interpreter": "A String", # Required. The script interpreter to use. + "outputFilePath": "A String", # 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. "script": "A String", # An inline script. The size of the script is limited to 1024 characters. }, }, @@ -756,11 +762,11 @@

Method Details

}, "id": "A String", # 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. "pkg": { # A resource that manages a system package. # Package resource - "apt": { # A package managed by APT. install: `apt-get update && apt-get -y install [name]` remove: `apt-get -y remove [name]` # A package managed by Apt. + "apt": { # A package managed by APT. - install: `apt-get update && apt-get -y install [name]` - remove: `apt-get -y remove [name]` # A package managed by Apt. "name": "A String", # Required. Package name. }, "deb": { # A deb package file. dpkg packages only support INSTALLED state. # A deb package file. - "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `dpkg -i package` install when true: `apt-get update && apt-get -y install package.deb` + "pullDeps": True or False, # Whether dependencies should also be installed. - install when false: `dpkg -i package` - install when true: `apt-get update && apt-get -y install package.deb` "source": { # A remote or local file. # Required. A deb package. "allowInsecure": True or False, # 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. "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. @@ -776,11 +782,11 @@

Method Details

}, }, "desiredState": "A String", # Required. The desired state the agent should maintain for this package. - "googet": { # A package managed by GooGet. install: `googet -noconfirm install package` remove: `googet -noconfirm remove package` # A package managed by GooGet. + "googet": { # A package managed by GooGet. - install: `googet -noconfirm install package` - remove: `googet -noconfirm remove package` # A package managed by GooGet. "name": "A String", # Required. Package name. }, "msi": { # An MSI package. MSI packages only support INSTALLED state. # An MSI package. - "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of "ACTION=INSTALL REBOOT=ReallySuppress". + "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of `ACTION=INSTALL REBOOT=ReallySuppress`. "A String", ], "source": { # A remote or local file. # Required. The MSI package. @@ -798,7 +804,7 @@

Method Details

}, }, "rpm": { # An RPM package file. RPM packages only support INSTALLED state. # An rpm package file. - "pullDeps": True or False, # 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` + "pullDeps": True or False, # 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` "source": { # A remote or local file. # Required. An rpm package. "allowInsecure": True or False, # 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. "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. @@ -813,21 +819,21 @@

Method Details

}, }, }, - "yum": { # A package managed by YUM. install: `yum -y install package` remove: `yum -y remove package` # A package managed by YUM. + "yum": { # A package managed by YUM. - install: `yum -y install package` - remove: `yum -y remove package` # A package managed by YUM. "name": "A String", # Required. Package name. }, - "zypper": { # A package managed by Zypper. install: `zypper -y install package` remove: `zypper -y rm package` # A package managed by Zypper. + "zypper": { # A package managed by Zypper. - install: `zypper -y install package` - remove: `zypper -y rm package` # A package managed by Zypper. "name": "A String", # Required. Package name. }, }, "repository": { # A resource that manages a package repository. # Package repository resource - "apt": { # 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. # An Apt Repository. + "apt": { # 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`. # An Apt Repository. "archiveType": "A String", # Required. Type of archive files in this repository. "components": [ # Required. List of components for this repository. Must contain at least one item. "A String", ], "distribution": "A String", # Required. Distribution of this repository. - "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at /etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg. + "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg`. "uri": "A String", # Required. URI for this repository. }, "goo": { # Represents a Goo package repository. These are added to a repo file that is managed at `C:/ProgramData/GooGet/repos/google_osconfig.repo`. # A Goo Repository. @@ -893,7 +899,7 @@

Method Details

{ # A response message for listing all revisions for a OS policy assignment. "nextPageToken": "A String", # The pagination token to retrieve the next page of OS policy assignment revisions. "osPolicyAssignments": [ # The OS policy assignment revisions - { # 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](/compute/docs/os-configuration-management/working-with-os-policies). + { # 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). "baseline": True or False, # 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. "deleted": True or False, # Output only. Indicates that this revision deletes the OS policy assignment. "description": "A String", # OS policy assignment description. Length of the description is limited to 1024 characters. @@ -951,6 +957,7 @@

Method Details

}, }, "interpreter": "A String", # Required. The script interpreter to use. + "outputFilePath": "A String", # 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. "script": "A String", # An inline script. The size of the script is limited to 1024 characters. }, "validate": { # A file or script to execute. # 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. @@ -971,6 +978,7 @@

Method Details

}, }, "interpreter": "A String", # Required. The script interpreter to use. + "outputFilePath": "A String", # 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. "script": "A String", # An inline script. The size of the script is limited to 1024 characters. }, }, @@ -995,11 +1003,11 @@

Method Details

}, "id": "A String", # 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. "pkg": { # A resource that manages a system package. # Package resource - "apt": { # A package managed by APT. install: `apt-get update && apt-get -y install [name]` remove: `apt-get -y remove [name]` # A package managed by Apt. + "apt": { # A package managed by APT. - install: `apt-get update && apt-get -y install [name]` - remove: `apt-get -y remove [name]` # A package managed by Apt. "name": "A String", # Required. Package name. }, "deb": { # A deb package file. dpkg packages only support INSTALLED state. # A deb package file. - "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `dpkg -i package` install when true: `apt-get update && apt-get -y install package.deb` + "pullDeps": True or False, # Whether dependencies should also be installed. - install when false: `dpkg -i package` - install when true: `apt-get update && apt-get -y install package.deb` "source": { # A remote or local file. # Required. A deb package. "allowInsecure": True or False, # 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. "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. @@ -1015,11 +1023,11 @@

Method Details

}, }, "desiredState": "A String", # Required. The desired state the agent should maintain for this package. - "googet": { # A package managed by GooGet. install: `googet -noconfirm install package` remove: `googet -noconfirm remove package` # A package managed by GooGet. + "googet": { # A package managed by GooGet. - install: `googet -noconfirm install package` - remove: `googet -noconfirm remove package` # A package managed by GooGet. "name": "A String", # Required. Package name. }, "msi": { # An MSI package. MSI packages only support INSTALLED state. # An MSI package. - "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of "ACTION=INSTALL REBOOT=ReallySuppress". + "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of `ACTION=INSTALL REBOOT=ReallySuppress`. "A String", ], "source": { # A remote or local file. # Required. The MSI package. @@ -1037,7 +1045,7 @@

Method Details

}, }, "rpm": { # An RPM package file. RPM packages only support INSTALLED state. # An rpm package file. - "pullDeps": True or False, # 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` + "pullDeps": True or False, # 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` "source": { # A remote or local file. # Required. An rpm package. "allowInsecure": True or False, # 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. "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. @@ -1052,21 +1060,21 @@

Method Details

}, }, }, - "yum": { # A package managed by YUM. install: `yum -y install package` remove: `yum -y remove package` # A package managed by YUM. + "yum": { # A package managed by YUM. - install: `yum -y install package` - remove: `yum -y remove package` # A package managed by YUM. "name": "A String", # Required. Package name. }, - "zypper": { # A package managed by Zypper. install: `zypper -y install package` remove: `zypper -y rm package` # A package managed by Zypper. + "zypper": { # A package managed by Zypper. - install: `zypper -y install package` - remove: `zypper -y rm package` # A package managed by Zypper. "name": "A String", # Required. Package name. }, }, "repository": { # A resource that manages a package repository. # Package repository resource - "apt": { # 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. # An Apt Repository. + "apt": { # 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`. # An Apt Repository. "archiveType": "A String", # Required. Type of archive files in this repository. "components": [ # Required. List of components for this repository. Must contain at least one item. "A String", ], "distribution": "A String", # Required. Distribution of this repository. - "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at /etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg. + "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg`. "uri": "A String", # Required. URI for this repository. }, "goo": { # Represents a Goo package repository. These are added to a repo file that is managed at `C:/ProgramData/GooGet/repos/google_osconfig.repo`. # A Goo Repository. @@ -1143,14 +1151,14 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
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](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
+  
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).
 
 Args:
   name: string, Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` This field is ignored when you create an OS policy assignment. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # 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](/compute/docs/os-configuration-management/working-with-os-policies).
+{ # 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).
   "baseline": True or False, # 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.
   "deleted": True or False, # Output only. Indicates that this revision deletes the OS policy assignment.
   "description": "A String", # OS policy assignment description. Length of the description is limited to 1024 characters.
@@ -1208,6 +1216,7 @@ 

Method Details

}, }, "interpreter": "A String", # Required. The script interpreter to use. + "outputFilePath": "A String", # 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. "script": "A String", # An inline script. The size of the script is limited to 1024 characters. }, "validate": { # A file or script to execute. # 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. @@ -1228,6 +1237,7 @@

Method Details

}, }, "interpreter": "A String", # Required. The script interpreter to use. + "outputFilePath": "A String", # 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. "script": "A String", # An inline script. The size of the script is limited to 1024 characters. }, }, @@ -1252,11 +1262,11 @@

Method Details

}, "id": "A String", # 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. "pkg": { # A resource that manages a system package. # Package resource - "apt": { # A package managed by APT. install: `apt-get update && apt-get -y install [name]` remove: `apt-get -y remove [name]` # A package managed by Apt. + "apt": { # A package managed by APT. - install: `apt-get update && apt-get -y install [name]` - remove: `apt-get -y remove [name]` # A package managed by Apt. "name": "A String", # Required. Package name. }, "deb": { # A deb package file. dpkg packages only support INSTALLED state. # A deb package file. - "pullDeps": True or False, # Whether dependencies should also be installed. install when false: `dpkg -i package` install when true: `apt-get update && apt-get -y install package.deb` + "pullDeps": True or False, # Whether dependencies should also be installed. - install when false: `dpkg -i package` - install when true: `apt-get update && apt-get -y install package.deb` "source": { # A remote or local file. # Required. A deb package. "allowInsecure": True or False, # 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. "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. @@ -1272,11 +1282,11 @@

Method Details

}, }, "desiredState": "A String", # Required. The desired state the agent should maintain for this package. - "googet": { # A package managed by GooGet. install: `googet -noconfirm install package` remove: `googet -noconfirm remove package` # A package managed by GooGet. + "googet": { # A package managed by GooGet. - install: `googet -noconfirm install package` - remove: `googet -noconfirm remove package` # A package managed by GooGet. "name": "A String", # Required. Package name. }, "msi": { # An MSI package. MSI packages only support INSTALLED state. # An MSI package. - "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of "ACTION=INSTALL REBOOT=ReallySuppress". + "properties": [ # Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of `ACTION=INSTALL REBOOT=ReallySuppress`. "A String", ], "source": { # A remote or local file. # Required. The MSI package. @@ -1294,7 +1304,7 @@

Method Details

}, }, "rpm": { # An RPM package file. RPM packages only support INSTALLED state. # An rpm package file. - "pullDeps": True or False, # 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` + "pullDeps": True or False, # 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` "source": { # A remote or local file. # Required. An rpm package. "allowInsecure": True or False, # 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. "gcs": { # Specifies a file available as a Cloud Storage Object. # A Cloud Storage object. @@ -1309,21 +1319,21 @@

Method Details

}, }, }, - "yum": { # A package managed by YUM. install: `yum -y install package` remove: `yum -y remove package` # A package managed by YUM. + "yum": { # A package managed by YUM. - install: `yum -y install package` - remove: `yum -y remove package` # A package managed by YUM. "name": "A String", # Required. Package name. }, - "zypper": { # A package managed by Zypper. install: `zypper -y install package` remove: `zypper -y rm package` # A package managed by Zypper. + "zypper": { # A package managed by Zypper. - install: `zypper -y install package` - remove: `zypper -y rm package` # A package managed by Zypper. "name": "A String", # Required. Package name. }, }, "repository": { # A resource that manages a package repository. # Package repository resource - "apt": { # 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. # An Apt Repository. + "apt": { # 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`. # An Apt Repository. "archiveType": "A String", # Required. Type of archive files in this repository. "components": [ # Required. List of components for this repository. Must contain at least one item. "A String", ], "distribution": "A String", # Required. Distribution of this repository. - "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at /etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg. + "gpgKey": "A String", # URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg`. "uri": "A String", # Required. URI for this repository. }, "goo": { # Represents a Goo package repository. These are added to a repo file that is managed at `C:/ProgramData/GooGet/repos/google_osconfig.repo`. # A Goo Repository. diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1.json b/googleapiclient/discovery_cache/documents/osconfig.v1.json index db139e3e227..1f4cff51461 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1.json @@ -476,7 +476,7 @@ } } }, - "revision": "20210430", + "revision": "20210507", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptSettings": { diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json b/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json index 5511a3fba9b..37312906bcd 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json @@ -356,7 +356,7 @@ "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](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).", + "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", @@ -389,7 +389,7 @@ ] }, "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](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).", + "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", @@ -511,7 +511,7 @@ ] }, "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](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).", + "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", @@ -610,7 +610,7 @@ } } }, - "revision": "20210430", + "revision": "20210507", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CVSSv3": { @@ -789,7 +789,7 @@ "type": "object" }, "InstanceOSPoliciesCompliance": { - "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](/compute/docs/os-configuration-management/view-compliance).", + "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": { @@ -894,7 +894,7 @@ "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](/compute/docs/instances/os-inventory-management#data-collected).", + "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": { @@ -1323,7 +1323,7 @@ "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](/compute/docs/os-configuration-management/working-with-os-policies).", + "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": { @@ -1572,6 +1572,10 @@ }, "type": "array" }, + "execResourceOutput": { + "$ref": "OSPolicyResourceComplianceExecResourceOutput", + "description": "ExecResource specific output." + }, "osPolicyResourceId": { "description": "The id of the OS policy resource.", "type": "string" @@ -1597,6 +1601,18 @@ }, "type": "object" }, + "OSPolicyResourceComplianceExecResourceOutput": { + "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": { "description": "Step performed by the OS Config agent for configuring an `OSPolicyResource` to its desired state.", "id": "OSPolicyResourceConfigStep", @@ -1682,6 +1698,10 @@ ], "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 1024 characters.", "type": "string" @@ -1854,7 +1874,7 @@ "type": "object" }, "OSPolicyResourcePackageResourceAPT": { - "description": "A package managed by APT. install: `apt-get update && apt-get -y install [name]` remove: `apt-get -y remove [name]`", + "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": { @@ -1869,7 +1889,7 @@ "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`", + "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": { @@ -1880,7 +1900,7 @@ "type": "object" }, "OSPolicyResourcePackageResourceGooGet": { - "description": "A package managed by GooGet. install: `googet -noconfirm install package` remove: `googet -noconfirm remove package`", + "description": "A package managed by GooGet. - install: `googet -noconfirm install package` - remove: `googet -noconfirm remove package`", "id": "OSPolicyResourcePackageResourceGooGet", "properties": { "name": { @@ -1895,7 +1915,7 @@ "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\".", + "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" }, @@ -1913,7 +1933,7 @@ "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`", + "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": { @@ -1924,7 +1944,7 @@ "type": "object" }, "OSPolicyResourcePackageResourceYUM": { - "description": "A package managed by YUM. install: `yum -y install package` remove: `yum -y remove package`", + "description": "A package managed by YUM. - install: `yum -y install package` - remove: `yum -y remove package`", "id": "OSPolicyResourcePackageResourceYUM", "properties": { "name": { @@ -1935,7 +1955,7 @@ "type": "object" }, "OSPolicyResourcePackageResourceZypper": { - "description": "A package managed by Zypper. install: `zypper -y install package` remove: `zypper -y rm package`", + "description": "A package managed by Zypper. - install: `zypper -y install package` - remove: `zypper -y rm package`", "id": "OSPolicyResourcePackageResourceZypper", "properties": { "name": { @@ -1969,7 +1989,7 @@ "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.", + "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": { @@ -1998,7 +2018,7 @@ "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.", + "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": { @@ -2138,7 +2158,7 @@ "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](/compute/docs/instances/os-inventory-management#vulnerability-reports).", + "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": { "name": { diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1beta.json b/googleapiclient/discovery_cache/documents/osconfig.v1beta.json index 9ced4c5ca6b..06d24770eba 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1beta.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1beta.json @@ -599,7 +599,7 @@ } } }, - "revision": "20210430", + "revision": "20210507", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptRepository": {