The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of10, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.
getMode
Mode of the patch rollout.
Returns
Type
Description
int
setMode
Mode of the patch rollout.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getDisruptionBudget
The maximum number (or percentage) of VMs per zone to disrupt at any given
moment. The number of VMs calculated from multiplying the percentage by the
total number of VMs in a zone is rounded up.
During patching, a VM is considered disrupted from the time the agent is
notified to begin until patching has completed. This disruption time
includes the time to complete reboot and any post-patch steps.
A VM contributes to the disruption budget if its patching operation fails
either when applying the patches, running pre or post patch steps, or if it
fails to respond with a success notification before timing out. VMs that
are not running or do not have an active agent do not count toward this
disruption budget.
For zone-by-zone rollouts, if the disruption budget in a zone is exceeded,
the patch job stops, because continuing to the next zone requires
completion of the patch process in the previous zone.
For example, if the disruption budget has a fixed value of10, and 8 VMs
fail to patch in the current zone, the patch job continues to patch 2 VMs
at a time until the zone is completed. When that zone is completed
successfully, patching begins with 10 VMs at a time in the next zone. If 10
VMs in the next zone fail to patch, the patch job stops.
The maximum number (or percentage) of VMs per zone to disrupt at any given
moment. The number of VMs calculated from multiplying the percentage by the
total number of VMs in a zone is rounded up.
During patching, a VM is considered disrupted from the time the agent is
notified to begin until patching has completed. This disruption time
includes the time to complete reboot and any post-patch steps.
A VM contributes to the disruption budget if its patching operation fails
either when applying the patches, running pre or post patch steps, or if it
fails to respond with a success notification before timing out. VMs that
are not running or do not have an active agent do not count toward this
disruption budget.
For zone-by-zone rollouts, if the disruption budget in a zone is exceeded,
the patch job stops, because continuing to the next zone requires
completion of the patch process in the previous zone.
For example, if the disruption budget has a fixed value of10, and 8 VMs
fail to patch in the current zone, the patch job continues to patch 2 VMs
at a time until the zone is completed. When that zone is completed
successfully, patching begins with 10 VMs at a time in the next zone. If 10
VMs in the next zone fail to patch, the patch job stops.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud OsConfig V1 Client - Class PatchRollout (2.1.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.0 (latest)](/php/docs/reference/cloud-osconfig/latest/V1.PatchRollout)\n- [2.0.5](/php/docs/reference/cloud-osconfig/2.0.5/V1.PatchRollout)\n- [1.3.5](/php/docs/reference/cloud-osconfig/1.3.5/V1.PatchRollout)\n- [1.2.2](/php/docs/reference/cloud-osconfig/1.2.2/V1.PatchRollout)\n- [1.1.1](/php/docs/reference/cloud-osconfig/1.1.1/V1.PatchRollout)\n- [1.0.5](/php/docs/reference/cloud-osconfig/1.0.5/V1.PatchRollout) \nReference documentation and code samples for the Google Cloud OsConfig V1 Client class PatchRollout.\n\nPatch rollout configuration specifications. Contains details on the\nconcurrency control when applying patch(es) to all targeted VMs.\n\nGenerated from protobuf message `google.cloud.osconfig.v1.PatchRollout`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ OsConfig \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getMode\n\nMode of the patch rollout.\n\n### setMode\n\nMode of the patch rollout.\n\n### getDisruptionBudget\n\nThe maximum number (or percentage) of VMs per zone to disrupt at any given\nmoment. The number of VMs calculated from multiplying the percentage by the\ntotal number of VMs in a zone is rounded up.\n\nDuring patching, a VM is considered disrupted from the time the agent is\nnotified to begin until patching has completed. This disruption time\nincludes the time to complete reboot and any post-patch steps.\nA VM contributes to the disruption budget if its patching operation fails\neither when applying the patches, running pre or post patch steps, or if it\nfails to respond with a success notification before timing out. VMs that\nare not running or do not have an active agent do not count toward this\ndisruption budget.\nFor zone-by-zone rollouts, if the disruption budget in a zone is exceeded,\nthe patch job stops, because continuing to the next zone requires\ncompletion of the patch process in the previous zone.\nFor example, if the disruption budget has a fixed value of `10`, and 8 VMs\nfail to patch in the current zone, the patch job continues to patch 2 VMs\nat a time until the zone is completed. When that zone is completed\nsuccessfully, patching begins with 10 VMs at a time in the next zone. If 10\nVMs in the next zone fail to patch, the patch job stops.\n\n### hasDisruptionBudget\n\n### clearDisruptionBudget\n\n### setDisruptionBudget\n\nThe maximum number (or percentage) of VMs per zone to disrupt at any given\nmoment. The number of VMs calculated from multiplying the percentage by the\ntotal number of VMs in a zone is rounded up.\n\nDuring patching, a VM is considered disrupted from the time the agent is\nnotified to begin until patching has completed. This disruption time\nincludes the time to complete reboot and any post-patch steps.\nA VM contributes to the disruption budget if its patching operation fails\neither when applying the patches, running pre or post patch steps, or if it\nfails to respond with a success notification before timing out. VMs that\nare not running or do not have an active agent do not count toward this\ndisruption budget.\nFor zone-by-zone rollouts, if the disruption budget in a zone is exceeded,\nthe patch job stops, because continuing to the next zone requires\ncompletion of the patch process in the previous zone.\nFor example, if the disruption budget has a fixed value of `10`, and 8 VMs\nfail to patch in the current zone, the patch job continues to patch 2 VMs\nat a time until the zone is completed. When that zone is completed\nsuccessfully, patching begins with 10 VMs at a time in the next zone. If 10\nVMs in the next zone fail to patch, the patch job stops."]]
