Install all missing patches in specific systems

  • Functionality
  • Install all missing patches in specific systems
  • HTTP Method
  • POST
  • API URI
  • api/1.3/patch/installpatch
  • Scope
  • PatchManagerPlusCloud.PatchMgmt.UPDATE

Example Request Data

{ "ResourceIDs":[601],
   "isOnlyApproved":"true",
 "ConfigName":"API install patch test1",
   "ConfigDescription":"API test",
   "actionToPerform":"Deploy",
   "DeploymentPolicyTemplateID":1,
  "deploymentType": 2,
   "deadlineTime": 1691393760,
  "forceRebootOption":2,
  "retrySettings":
 {
 "enableRetrySettings": true,
 "noOfRetries": 2,
   "logonStartupMinRetry": 1,
 "refreshMinRetry": 1
 }
 }

Request Data Details

  • PatchIDs
  • Enter the list of missing patches detected in your network. This parameter is mandatory.
    E.g. "PatchIDs":[103980,103981,103980]
  • ResourceIDs
  • Enter the list of resources with missing patches in your network.
    E.g. "ResourceIDs":[601,602]
  • isOnlyApproved
  • Patches are marked as approved based on the settings configured in Deployment -> Test and Approve -> Patch Approval Status.
    E.g. "isOnlyApproved":"true" - Deploy only approved patches from the provided patch IDs.
    "isOnlyApproved":"false" - Deploy all patches from the provided patch IDs.
    This parameter is optional.
  • ConfigName
  • Provide a name for the Install Patch configuration.
    E.g. "ConfigName":"API install patch test1" - This parameter is mandatory.
  • ConfigDescription
  • Provide a description for the Install Patch configuration.
    E.g. ConfigDescription":"API test" - This parameter is mandatory.
  • actionToPerform
  • This will initiate deployment of the defined Install Patches Configuration to the specified targets in accordance with the provided criteria. This parameter is mandatory.
    E.g. "actionToPerform":"Deploy/ Deploy Immediately/ Draft"
    Deploy : The deployment will initiate upon the agent's contact with the server.
    Deploy Immediately : Deployed instantly without waiting for agent contact.
    Draft : Save the configuration as a draft.
  • DeploymentPolicyTemplateID
  • Retrieve the Deployment Policy ID by executing the following API, /api/1.4/patch/deploymentpolicies and and provide the value of the "template_id" param value. This paramater is mandatory.
  • deploymentType
  • Provide the preferred deployment option here. Accepted values : 0/1/2.
    E.g. "deploymentType": 0/1/2
    0 - Deploy only (default)
    This option enables you to deploy the selected patches to the targeted endpoints according to the relevant deployment policies.
    1 - Publish in Self Service Portal only (DeploymentPolicyTemplateID will be ignored).
    This option enables administrators to publish the selected patches to the Self Service Portal. End users and server owners can then initiate the installation process at their convenience.
    2 - This option incorporates both deployment and publication actions.
    Note: If deploymentType is set to 0 or 1, then the DeploymentPolicyTemplateID field is mandatory.
  • deadlineTime
  • Specify the time, in milliseconds, for force deploying the patches to unpatched systems in your network.
    E.g. "deadlineTime": 1691393760 (Time in milliseconds).
    Note : Max of 1 year is supported.
  • forceRebootOption
  • Depending on the selected Deployment Policy, you can choose to enable Force Reboot either within or outside the deployment window. Accepted Values : 0/1/2.
    E.g. "forceRebootOption":0/1/2
    0 - Not configured.
    1 - Within the deployment/reboot window.
    2 - Outside the deployment/reboot window.
  • retrySettings
  • Enabling this option will redeploy the configuration on failed targets.
    E.g. "retrySettings":
    {
    "enableRetrySettings": true,
    "noOfRetries": 2,
    "logonStartupMinRetry": 1,
    "refreshMinRetry": 1
    }
    enableRetrySettings
    true : To enable retry settings.
    false: To disable retry settings.
    noOfRetries
    Total number of retries count . Accepted values 1-10.
    logonStartupMinRetry
    Retry during system startup.
    refreshMinRetry
    Retry during refresh cycle.
    Note : Enabled by default. To disable, set 'enableRetrySettings' to false. Retry count: logonStartupMinRetry + refreshMinRetry.
  • Target settings
  • Specify the required targets for deployment. Select one target set from the options provided below:
    "ResourceIDs":[601,602],
    "resourceNames":["abc","xyz"],
    "customGroups":["CG1","CG2"],
    "ipAddresses":["127.0.0.1","126.0.0.1"],
    "remoteOffices":["Local","remote"]
  • installaftertime
  • Specify the date and time for patch installation to begin. Patches will be installed based on the selected options after the scheduled time. Use the format: yyyy-MM-dd HH:MM.
  • expirytime
  • This configuration will not be applied after the specified time. Use the format yyyy-MM-dd HH:MM.