OS Config API: projects. OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances. See: https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects
OS Config API: projects. OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances. See: https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects
(locations-instances-inventories-get$ auth parameters)
Required parameters: name
Optional parameters: view
Get inventory data for the specified VM instance. If the VM has no associated inventory, the message NOT_FOUND
is returned.
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/locations/instances/inventories/get Required parameters: name Optional parameters: view Get inventory data for the specified VM instance. If the VM has no associated inventory, the message `NOT_FOUND` is returned.
(locations-instances-inventories-list$ auth parameters)
Required parameters: parent
Optional parameters: view, pageToken, filter, pageSize
List inventory data for all VM instances in the specified zone.
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/locations/instances/inventories/list Required parameters: parent Optional parameters: view, pageToken, filter, pageSize List inventory data for all VM instances in the specified zone.
(locations-instances-vulnerabilityReports-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them.
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/locations/instances/vulnerabilityReports/get Required parameters: name Optional parameters: none Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them.
(locations-instances-vulnerabilityReports-list$ auth parameters)
Required parameters: parent
Optional parameters: filter, pageToken, pageSize
List vulnerability reports for all VM instances in the specified zone.
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/locations/instances/vulnerabilityReports/list Required parameters: parent Optional parameters: filter, pageToken, pageSize List vulnerability reports for all VM instances in the specified zone.
(locations-osPolicyAssignments-create$ auth parameters body)
Required parameters: parent
Optional parameters: osPolicyAssignmentId
Body:
{:description string, :baseline boolean, :deleted boolean, :rolloutState string, :revisionCreateTime string, :uid string, :name string, :revisionId string, :osPolicies [{:description string, :mode string, :resourceGroups [OSPolicyResourceGroup], :id string, :allowNoResourceGroupMatch boolean}], :etag string, :reconciling boolean, :rollout {:disruptionBudget FixedOrPercent, :minWaitDuration string}, :instanceFilter {:exclusionLabels [OSPolicyAssignmentLabelSet], :inventories [OSPolicyAssignmentInstanceFilterInventory], :all boolean, :inclusionLabels [OSPolicyAssignmentLabelSet]}}
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/restapi/reference/rest/v1/projects/locations/osPolicyAssignments/create Required parameters: parent Optional parameters: osPolicyAssignmentId Body: {:description string, :baseline boolean, :deleted boolean, :rolloutState string, :revisionCreateTime string, :uid string, :name string, :revisionId string, :osPolicies [{:description string, :mode string, :resourceGroups [OSPolicyResourceGroup], :id string, :allowNoResourceGroupMatch boolean}], :etag string, :reconciling boolean, :rollout {:disruptionBudget FixedOrPercent, :minWaitDuration string}, :instanceFilter {:exclusionLabels [OSPolicyAssignmentLabelSet], :inventories [OSPolicyAssignmentInstanceFilterInventory], :all boolean, :inclusionLabels [OSPolicyAssignmentLabelSet]}} 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/v1/projects.locations.osPolicyAssignments.operations/cancel).
(locations-osPolicyAssignments-delete$ auth parameters)
Required parameters: name
Optional parameters: 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.
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/locations/osPolicyAssignments/delete Required parameters: name Optional parameters: 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](https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel).
(locations-osPolicyAssignments-get$ auth parameters)
Required parameters: name
Optional parameters: 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.
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/locations/osPolicyAssignments/get Required parameters: name Optional parameters: 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.
(locations-osPolicyAssignments-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken
List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned.
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/locations/osPolicyAssignments/list Required parameters: parent Optional parameters: pageSize, pageToken List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned.
(locations-osPolicyAssignments-listRevisions$ auth parameters)
Required parameters: name
Optional parameters: pageSize, pageToken
List the OS policy assignment revisions for a given OS policy assignment.
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/locations/osPolicyAssignments/listRevisions Required parameters: name Optional parameters: pageSize, pageToken List the OS policy assignment revisions for a given OS policy assignment.
(locations-osPolicyAssignments-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:description string, :baseline boolean, :deleted boolean, :rolloutState string, :revisionCreateTime string, :uid string, :name string, :revisionId string, :osPolicies [{:description string, :mode string, :resourceGroups [OSPolicyResourceGroup], :id string, :allowNoResourceGroupMatch boolean}], :etag string, :reconciling boolean, :rollout {:disruptionBudget FixedOrPercent, :minWaitDuration string}, :instanceFilter {:exclusionLabels [OSPolicyAssignmentLabelSet], :inventories [OSPolicyAssignmentInstanceFilterInventory], :all boolean, :inclusionLabels [OSPolicyAssignmentLabelSet]}}
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/restapi/reference/rest/v1/projects/locations/osPolicyAssignments/patch Required parameters: name Optional parameters: updateMask Body: {:description string, :baseline boolean, :deleted boolean, :rolloutState string, :revisionCreateTime string, :uid string, :name string, :revisionId string, :osPolicies [{:description string, :mode string, :resourceGroups [OSPolicyResourceGroup], :id string, :allowNoResourceGroupMatch boolean}], :etag string, :reconciling boolean, :rollout {:disruptionBudget FixedOrPercent, :minWaitDuration string}, :instanceFilter {:exclusionLabels [OSPolicyAssignmentLabelSet], :inventories [OSPolicyAssignmentInstanceFilterInventory], :all boolean, :inclusionLabels [OSPolicyAssignmentLabelSet]}} 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/v1/projects.locations.osPolicyAssignments.operations/cancel).
(patchDeployments-create$ auth parameters body)
Required parameters: parent
Optional parameters: patchDeploymentId
Body:
{:description string, :lastExecuteTime string, :name string, :patchConfig {:postStep ExecStep, :apt AptSettings, :windowsUpdate WindowsUpdateSettings, :yum YumSettings, :preStep ExecStep, :rebootConfig string, :zypper ZypperSettings, :goo GooSettings}, :createTime string, :duration string, :updateTime string, :recurringSchedule {:timeZone TimeZone, :lastExecuteTime string, :nextExecuteTime string, :startTime string, :endTime string, :frequency string, :monthly MonthlySchedule, :weekly WeeklySchedule, :timeOfDay TimeOfDay}, :oneTimeSchedule {:executeTime string}, :rollout {:mode string, :disruptionBudget FixedOrPercent}, :instanceFilter {:zones [string], :instanceNamePrefixes [string], :groupLabels [PatchInstanceFilterGroupLabel], :instances [string], :all boolean}}
Create an OS Config patch deployment.
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/patchDeployments/create Required parameters: parent Optional parameters: patchDeploymentId Body: {:description string, :lastExecuteTime string, :name string, :patchConfig {:postStep ExecStep, :apt AptSettings, :windowsUpdate WindowsUpdateSettings, :yum YumSettings, :preStep ExecStep, :rebootConfig string, :zypper ZypperSettings, :goo GooSettings}, :createTime string, :duration string, :updateTime string, :recurringSchedule {:timeZone TimeZone, :lastExecuteTime string, :nextExecuteTime string, :startTime string, :endTime string, :frequency string, :monthly MonthlySchedule, :weekly WeeklySchedule, :timeOfDay TimeOfDay}, :oneTimeSchedule {:executeTime string}, :rollout {:mode string, :disruptionBudget FixedOrPercent}, :instanceFilter {:zones [string], :instanceNamePrefixes [string], :groupLabels [PatchInstanceFilterGroupLabel], :instances [string], :all boolean}} Create an OS Config patch deployment.
(patchDeployments-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Delete an OS Config patch deployment.
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/patchDeployments/delete Required parameters: name Optional parameters: none Delete an OS Config patch deployment.
(patchDeployments-get$ auth parameters)
Required parameters: name
Optional parameters: none
Get an OS Config patch deployment.
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/patchDeployments/get Required parameters: name Optional parameters: none Get an OS Config patch deployment.
(patchDeployments-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken
Get a page of OS Config patch deployments.
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/patchDeployments/list Required parameters: parent Optional parameters: pageSize, pageToken Get a page of OS Config patch deployments.
(patchJobs-cancel$ auth parameters body)
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/patchJobs/cancel
Required parameters: name
Optional parameters: none
Body:
{}
Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/patchJobs/cancel Required parameters: name Optional parameters: none Body: {} Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.
(patchJobs-execute$ auth parameters body)
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/patchJobs/execute
Required parameters: parent
Optional parameters: none
Body:
{:rollout {:mode string, :disruptionBudget FixedOrPercent}, :dryRun boolean, :description string, :duration string, :displayName string, :patchConfig {:postStep ExecStep, :apt AptSettings, :windowsUpdate WindowsUpdateSettings, :yum YumSettings, :preStep ExecStep, :rebootConfig string, :zypper ZypperSettings, :goo GooSettings}, :instanceFilter {:zones [string], :instanceNamePrefixes [string], :groupLabels [PatchInstanceFilterGroupLabel], :instances [string], :all boolean}}
Patch VM instances by creating and running a patch job.
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/patchJobs/execute Required parameters: parent Optional parameters: none Body: {:rollout {:mode string, :disruptionBudget FixedOrPercent}, :dryRun boolean, :description string, :duration string, :displayName string, :patchConfig {:postStep ExecStep, :apt AptSettings, :windowsUpdate WindowsUpdateSettings, :yum YumSettings, :preStep ExecStep, :rebootConfig string, :zypper ZypperSettings, :goo GooSettings}, :instanceFilter {:zones [string], :instanceNamePrefixes [string], :groupLabels [PatchInstanceFilterGroupLabel], :instances [string], :all boolean}} Patch VM instances by creating and running a patch job.
(patchJobs-get$ auth parameters)
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/patchJobs/get
Required parameters: name
Optional parameters: none
Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/patchJobs/get Required parameters: name Optional parameters: none Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.
(patchJobs-instanceDetails-list$ auth parameters)
Required parameters: parent
Optional parameters: filter, pageToken, pageSize
Get a list of instance details for a given patch job.
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/patchJobs/instanceDetails/list Required parameters: parent Optional parameters: filter, pageToken, pageSize Get a list of instance details for a given patch job.
(patchJobs-list$ auth parameters)
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/patchJobs/list
Required parameters: parent
Optional parameters: pageSize, filter, pageToken
Get a list of patch jobs.
https://cloud.google.com/compute/docs/osconfig/restapi/reference/rest/v1/projects/patchJobs/list Required parameters: parent Optional parameters: pageSize, filter, pageToken Get a list of patch jobs.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close