SoftLayer Software Component AntivirusSpyware::updateAntivirusSpywarePolicy

From SoftLayer Development Network Wiki

updateAntivirusSpywarePolicy is a member of the SoftLayer_Software_Component_AntivirusSpyware service.

Contents 1 Overview 2 Return Type 3 Headers 3.1 Required Headers 4 Parameters 4.1 newPolicy 5 Error Handling

Overview

Update an anti-virus/spyware policy. The policy options that it accepts are the following:

• 1 - Minimal
• 2 - Relaxed
• 3 - Default
• 4 - High
• 5 - Ultimate

Return Type

updateAntivirusSpywarePolicy returns the boolean data type.

Headers

Required Headers

updateAntivirusSpywarePolicy requires the following headers:

• authenticate
• SoftLayer_Software_Component_AntivirusSpywareInitParameters

Parameters

updateAntivirusSpywarePolicy takes the following parameters:

newPolicy

The new anti-virus policy.

• Type: string

Error Handling

updateAntivirusSpywarePolicy throws the following exceptions:

• SoftLayer_Exception_Software_Component_Mcafee_InvalidPolicyUpdateResponseCode

Throws the error "The host ips policy update page returned a failed response code."

• SoftLayer_Exception_Software_Component_Mcafee_PolicyUpdateFailure

Throws the error "The host ips policies could not be updated at this time."