CIM SMASH/Server Management API
Class CIM_Action
extends CIM_ManagedElement
A CIM_Action is an operation that is part of a process to either create a SoftwareElement in its next state or to eliminate the SoftwareElement in its current state. A CIM_ComputerSystem object represents the environment in which CIM_SoftwareElements are already deployed/installed or into which the elements will be deployed/installed. For the case in which an element is already installed, the CIM_InstalledSoftwareElement association identifies the CIM_ComputerSystem object that represents the "environment". When a SoftwareElement is being deployed for installation on a ComputerSystem, that system is the target of the Action and is identified using the TargetSystem reference of the InvokeOnSystem method.
Details...
This class is not implemented.
Subclasses
CIM_DirectoryAction CIM_ExecuteProgram CIM_FileAction CIM_ModifySettingAction CIM_RebootActionClass Qualifiers
| Name | Data Type | Value | Scope | Flavors |
|---|---|---|---|---|
| Abstract | boolean | true | TOSUBCLASS= false | None |
| Description | string | A CIM_Action is an operation that is part of a process to either create a SoftwareElement in its next state or to eliminate the SoftwareElement in its current state. A CIM_ComputerSystem object represents the environment in which CIM_SoftwareElements are already deployed/installed or into which the elements will be deployed/installed. For the case in which an element is already installed, the CIM_InstalledSoftwareElement association identifies the CIM_ComputerSystem object that represents the "environment". When a SoftwareElement is being deployed for installation on a ComputerSystem, that system is the target of the Action and is identified using the TargetSystem reference of the InvokeOnSystem method. | None | TRANSLATABLE= true |
| UMLPackagePath | string | CIM::Application::CheckAction | None | None |
| Version | string | 2.23.0 | TOSUBCLASS= false | TRANSLATABLE= true |
Local Class Properties
| Name | Data Type | Qualifiers | ||||
|---|---|---|---|---|---|---|
| Name | Data Type | Value | Scope | Flavors | ||
| ActionID | string | |||||
| Description | string | The ActionID property is a unique identifier assigned to a particular Action for a SoftwareElement. | None | TRANSLATABLE= true | ||
| Key | boolean | true | None | OVERRIDABLE= false |
||
| MaxLen | uint32 | 256 | None | None | ||
| Caption | string | |||||
| Description | string | The Caption property is a short textual description (one- line string) of the object. | None | TRANSLATABLE= true | ||
| MaxLen | uint32 | 64 | None | None | ||
| Description | string | |||||
| Description | string | The Description property provides a textual description of the object. | None | TRANSLATABLE= true | ||
| Direction | uint16 | |||||
| Description | string | The Direction property is used to indicate whether this Action is part of a sequence to transition the SoftwareElement to its next state ("Install") or to remove the element ("Uninstall"). | None | TRANSLATABLE= true | ||
| ValueMap | string | 0, 1 | None | None | ||
| Values | string | Install, Uninstall | None | TRANSLATABLE= true | ||
| ElementName | string | |||||
| Description | string | A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class. | None | TRANSLATABLE= true | ||
| InstanceID | string | |||||
| Description | string | InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: <OrgID>:<LocalID> Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>. <LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If not null and the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM. | None | TRANSLATABLE= true | ||
| Name | string | |||||
| Description | string | The name used to identify the SoftwareElement that is being acted upon. | None | TRANSLATABLE= true | ||
| Key | boolean | true | None | OVERRIDABLE= false |
||
| MaxLen | uint32 | 256 | None | None | ||
| Propagated | string | CIM_SoftwareElement.Name | None | OVERRIDABLE= false |
||
| SoftwareElementID | string | |||||
| Description | string | This is an identifier for the SoftwareElement being acted upon. | None | TRANSLATABLE= true | ||
| Key | boolean | true | None | OVERRIDABLE= false |
||
| MaxLen | uint32 | 256 | None | None | ||
| Propagated | string | CIM_SoftwareElement.SoftwareElementID | None | OVERRIDABLE= false |
||
| SoftwareElementState | uint16 | |||||
| Description | string | The SoftwareElementState of the SoftwareElement being acted upon. | None | TRANSLATABLE= true | ||
| Key | boolean | true | None | OVERRIDABLE= false |
||
| Propagated | string | CIM_SoftwareElement.SoftwareElementState | None | OVERRIDABLE= false |
||
| ValueMap | string | 0, 1, 2, 3 | None | None | ||
| Values | string | Deployable, Installable, Executable, Running | None | TRANSLATABLE= true | ||
| TargetOperatingSystem | uint16 | |||||
| Description | string | The Target Operating System of the SoftwareElement being acted upon. | None | TRANSLATABLE= true | ||
| Key | boolean | true | None | OVERRIDABLE= false |
||
| Propagated | string | CIM_SoftwareElement.TargetOperatingSystem | None | OVERRIDABLE= false |
||
| ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110 | None | None | ||
| Values | string | Unknown, Other, MACOS, ATTUNIX, DGUX, DECNT, Tru64 UNIX, OpenVMS, HPUX, AIX, MVS, OS400, OS/2, JavaVM, MSDOS, WIN3x, WIN95, WIN98, WINNT, WINCE, NCR3000, NetWare, OSF, DC/OS, Reliant UNIX, SCO UnixWare, SCO OpenServer, Sequent, IRIX, Solaris, SunOS, U6000, ASERIES, HP NonStop OS, HP NonStop OSS, BS2000, LINUX, Lynx, XENIX, VM, Interactive UNIX, BSDUNIX, FreeBSD, NetBSD, GNU Hurd, OS9, MACH Kernel, Inferno, QNX, EPOC, IxWorks, VxWorks, MiNT, BeOS, HP MPE, NextStep, PalmPilot, Rhapsody, Windows 2000, Dedicated, OS/390, VSE, TPF, Windows (R) Me, Caldera Open UNIX, OpenBSD, Not Applicable, Windows XP, z/OS, Microsoft Windows Server 2003, Microsoft Windows Server 2003 64-Bit, Windows XP 64-Bit, Windows XP Embedded, Windows Vista, Windows Vista 64-Bit, Windows Embedded for Point of Service, Microsoft Windows Server 2008, Microsoft Windows Server 2008 64-Bit, FreeBSD 64-Bit, RedHat Enterprise Linux, RedHat Enterprise Linux 64-Bit, Solaris 64-Bit, SUSE, SUSE 64-Bit, SLES, SLES 64-Bit, Novell OES, Novell Linux Desktop, Sun Java Desktop System, Mandriva, Mandriva 64-Bit, TurboLinux, TurboLinux 64-Bit, Ubuntu, Ubuntu 64-Bit, Debian, Debian 64-Bit, Linux 2.4.x, Linux 2.4.x 64-Bit, Linux 2.6.x, Linux 2.6.x 64-Bit, Linux 64-Bit, Other 64-Bit, Microsoft Windows Server 2008 R2, VMware ESXi, Microsoft Windows 7, CentOS 32-bit, CentOS 64-bit, Oracle Enterprise Linux 32-bit, Oracle Enterprise Linux 64-bit, eComStation 32-bitx | None | TRANSLATABLE= true | ||
| Version | string | |||||
| Description | string | The version of the SoftwareElement being acted upon. | None | TRANSLATABLE= true | ||
| Key | boolean | true | None | OVERRIDABLE= false |
||
| MaxLen | uint32 | 64 | None | None | ||
| Propagated | string | CIM_SoftwareElement.Version | None | OVERRIDABLE= false |
||
Local Methods
| Method Name | Return Type | Qualifiers | ||||
|---|---|---|---|---|---|---|
| Name | Data Type | Value | Scope | Flavors | ||
| Invoke() | uint32 | |||||
| Description | string | The Invoke method takes this Action. The details of how the Action is implemented are described by specific subclasses of CIM_Action. When the SoftwareElement being transitioned or eliminated is already installed, the CIM_InstalledSoftwareElement association identifies the CIM_ComputerSystem in whose context the Invoke is executed. If this association is not in place, then the InvokeOnSystem method should be used - since it identifies the TargetSystem as a parameter of the method. The results of the Invoke method are based on the return value. A zero is returned if the Action is satisfied. A one is returned if the method is not supported. Any other value indicates the Action is not satisfied. | None | TRANSLATABLE= true | ||
| Method Name | Return Type | Qualifiers | ||||
| Name | Data Type | Value | Scope | Flavors | ||
| InvokeOnSystem() | uint32 | |||||
| Description | string | The InvokeOnSystem method takes this Action. The details of how the Action is implemented are described by specific subclasses of CIM_Action. The method's TargetSystem input parameter specifies the ComputerSystem in whose context the method is invoked. The results of the InvokeOnSystem method are based on the return value. A zero is returned if the Action is satisfied. A one is returned if the method is not supported. Any other value indicates the Action is not satisfied. | None | TRANSLATABLE= true | ||
| Parameters | Qualifiers | |||||
| Name | Data Type | Name | Data Type | Value | Scope | Flavors |
| TargetSystem | CIM_ComputerSystem | |||||
| Description | string | Reference to target system in whose context the method is to be invoked. | None | TRANSLATABLE= true | ||
| IN | boolean | true | None | OVERRIDABLE= false |
||
Copyright © 2008-2020 VMware, Inc. All rights reserved.