PropertyInstance - deleteInstance
PropertyInstance - deleteInstance
Description :
This command attempts to delete a property set instance. If the instance is in use, you can use the force variable to deprecate the instance.
Note that this command works only on "visible" instances. To determine which instances are visible instances, start the BMC BladdeLogic GUI and display the Property Dictionary. A visible instance is any one of the following:
- Any instance that appears under Custom Property Classes in the Property Dictionary (every custom property class can have instances, and they are always "visible").
- Any instance that appears under Built-in Property Classes in the Property Dictionary. There are only a few classes whose instances are displayed in the Property Dictionary. Most built-in classes do not display their instances in the Property Dictionary (and therefore do not have "visible" instances). The built-in classes that have visible instances are those classes that display an "Instances" tab in the GUI, just like custom classes do.
So, to see if you can use this command on a given object, display the Property Dictionary, select the class associated with the object, and see if there is an Instances tab displayed in the GUI. If there is an Instances tab for the class in question, you can use this command.
If you want to work with a type of object that does not display its instances in the Property Dictionary, use a command from a namespace specific to the object you want to work with. For example, if you want to work with Server object, use commands in the Server namespace.
Return type : void
Command Input :
Variable Name |
Variable Type |
Description |
---|---|---|
fullyQualifiedInstanceName |
String |
Name of the instance. |
force |
Boolean |
Set this variable to true if you want to deprecate this instance if it is in use. |
Example
The following example attempts to delete the Dev instance of the ApacheOracle class.
Script
PropertyInstance deleteInstance Class://SystemObject/Application/Apache/ApacheOracle/Dev true
Comments
Log in or register to comment.