com.vmware.spbm.samples

Class EditProfile

java.lang.Object

com.vmware.spbm.connection.ConnectedServiceBase

com.vmware.spbm.samples.EditProfile

@Sample(name="editprofile",
        description="Updates a storage profile. Adds a new rule based on tags.")
public class EditProfile
extends ConnectedServiceBase

 EditProfile

 This sample updates a Tag-Based Storage Profile. Adds or deletes rulesets.
 Adds a ruleset based on tags from a tag category
 Deletes a ruleset from a storage profile.

 Parameters:
 url              [required] : url of the web service
 username         [required] : username for the authentication
 password         [required] : password for the authentication
 profilename     [required] : Name of the storage profile
 add              [optional] : Flag to denote addition of a rule set
 tag_category     [optional] : Category Name of the tags.
 delete           [optional] : Flag to denote deletion of a rule set
 ruleset_name     [optional] : Name of the ruleset

 Command Line:
 Update an existing profile with a new ruleset.
 The rule-set contains a rule based on tags from a tag-category.
 run.bat com.vmware.spbm.samples.EditProfile --url [webserviceurl]
 --username [username] --password [password]
 --profilename [Storage Profile Name]
 --add --tag_category [Category Name]

 Update an existing profile by deleting a ruleset from the storage profile
 run.bat com.vmware.spbm.samples.EditProfile --url [webserviceurl]
 --username [username] --password [password]
 --profilename [Storage Profile Name]
 --delete --ruleset_name [Ruleset Name]
 

Constructor Summary

Constructors

Constructor and Description
EditProfile()

Method Summary

Methods

Modifier and Type	Method and Description
void	editProfile()
void	setAddRuleSetName(java.lang.Boolean addRuleSet)
void	setDelRuleSetName(java.lang.Boolean delRuleSet)
void	setProfileName(java.lang.String profileName)
void	setRuleSetName(java.lang.String ruleSetName)
void	setTagCategoryName(java.lang.String tagCategoryName)

Methods inherited from class com.vmware.spbm.connection.ConnectedServiceBase

setConnection, start, stop

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EditProfile

public EditProfile()

Method Detail

editProfile

@Action
public void editProfile()
                 throws com.vmware.vim25.RuntimeFaultFaultMsg,
                        com.vmware.pbm.RuntimeFaultFaultMsg,
                        com.vmware.pbm.InvalidArgumentFaultMsg,
                        com.vmware.pbm.PbmDuplicateNameFaultMsg,
                        com.vmware.pbm.PbmFaultProfileStorageFaultFaultMsg

Throws:

com.vmware.vim25.RuntimeFaultFaultMsg

com.vmware.pbm.InvalidArgumentFaultMsg

com.vmware.pbm.PbmDuplicateNameFaultMsg

com.vmware.pbm.PbmFaultProfileStorageFaultFaultMsg

setAddRuleSetName

@Option(name="add",
        description="Flag to denote addition of a rule set. Requires tag_category property to be specified.",
        parameter=false,
        required=false)
public void setAddRuleSetName(java.lang.Boolean addRuleSet)

setDelRuleSetName

@Option(name="delete",
        description="Flag to denote deletion of a rule set. Requires ruleset_name property to be specified.",
        parameter=false,
        required=false)
public void setDelRuleSetName(java.lang.Boolean delRuleSet)

setProfileName

@Option(name="profilename",
        description="Name of an existing storage profile",
        required=true)
public void setProfileName(java.lang.String profileName)

setRuleSetName

@Option(name="ruleset_name",
        description="Name of the rule-set to be deleted.",
        required=false)
public void setRuleSetName(java.lang.String ruleSetName)

setTagCategoryName

@Option(name="tag_category",
        description="Category Name of the tags. All tags in this category are added to the rule.",
        required=false)
public void setTagCategoryName(java.lang.String tagCategoryName)