Msvm_GuestFileService, ROOT\virtualization\v2

Class | Methods (4) | Properties (28) | Qualifiers (4) | Instances | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

Represents the guest file service. It is used for interacting with files in a guest, from the Hyper-V host.

Msvm_GuestFileService methods

Msvm_GuestFileService has 4 methods (1 Local, 3 Derived)

NameOriginReturn
CopyFilesToGuestMsvm_GuestFileServiceuint32 {'out':True}
RequestStateChangeCIM_EnabledLogicalElementuint32 {'out':True}
StartServiceCIM_Serviceuint32 {'out':True}
StopServiceCIM_Serviceuint32 {'out':True}

Msvm_GuestFileService properties

Msvm_GuestFileService has 28 properties (28 Derived)

NameOriginCIMType
AvailableRequestedStatesCIM_EnabledLogicalElement18 [uint16]
CaptionCIM_ManagedElement8 [string]
CommunicationStatusCIM_ManagedSystemElement18 [uint16]
key
CreationClassName
CIM_Service8 [string]
DescriptionCIM_ManagedElement8 [string]
DetailedStatusCIM_ManagedSystemElement18 [uint16]
ElementNameCIM_ManagedElement8 [string]
EnabledDefaultCIM_EnabledLogicalElement18 [uint16]
EnabledStateCIM_EnabledLogicalElement18 [uint16]
HealthStateCIM_ManagedSystemElement18 [uint16]
InstallDateCIM_ManagedSystemElement101 [datetime]
InstanceIDCIM_ManagedElement8 [string]
key
Name
CIM_ManagedSystemElement8 [string]
OperatingStatusCIM_ManagedSystemElement18 [uint16]
OperationalStatusCIM_ManagedSystemElement18 [uint16]
OtherEnabledStateCIM_EnabledLogicalElement8 [string]
PrimaryOwnerContactCIM_Service8 [string]
PrimaryOwnerNameCIM_Service8 [string]
PrimaryStatusCIM_ManagedSystemElement18 [uint16]
RequestedStateCIM_EnabledLogicalElement18 [uint16]
StartedCIM_Service11 [boolean]
StartModeCIM_Service8 [string]
StatusCIM_ManagedSystemElement8 [string]
StatusDescriptionsCIM_ManagedSystemElement8 [string]
key
SystemCreationClassName
CIM_Service8 [string]
key
SystemName
CIM_Service8 [string]
TimeOfLastStateChangeCIM_EnabledLogicalElement101 [datetime]
TransitioningToStateCIM_EnabledLogicalElement18 [uint16]

Detailed description of Msvm_GuestFileService methods

Local methods (1) of Msvm_GuestFileService class

▲ CopyFilesToGuest method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
CopyFileToGuestSettingsstring0✓-{'Description':'Array of Msvm_CopyFileToGuestSettingData','HyperVEmbeddedInstance':'Msvm_CopyFileToGuestSettingData'}
Jobref:CIM_ConcreteJob1-✓{'Description':'An optional parameter for monitoring progress of the operation, which is used if the method could not be executed synchronously. If the operation is executing asynchronously, the return value is 4096.','Out':True}
Bypass_GetObjectTrue
Description'Copies files from the Hyper-V host to the guest.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
CopyFilesToGuest method is in 1 class (Msvm_GuestFileService) of ROOT\virtualization\v2 and in 2 namespaces

Derived methods (3) of Msvm_GuestFileService class

▲ RequestStateChange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RequestedStateuint160✓-{'Description':'The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.','ModelCorrespondence':['CIM_EnabledLogicalElement.RequestedState'],'ValueMap':['2', '3', '4', '6', '7', '8', '9', '10', '11', '..', '32768..65535'],'Values':['Enabled', 'Disabled', 'Shut Down', 'Offline', 'Test', 'Defer', 'Quiesce', 'Reboot', 'Reset', 'DMTF Reserved', 'Vendor Reserved']}
Jobref:CIM_ConcreteJob1-✓{'Description':'May contain a reference to the ConcreteJob created to track the state transition initiated by the method invocation.'}
TimeoutPerioddatetime2✓-{'Description':'A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' shall be returned.'}
RequestStateChange method is in 111 classes of ROOT\virtualization\v2 and in 15 namespaces
▲ StartService method
Returnuint32 {'out':True}
StartService method is in 23 classes of ROOT\virtualization\v2 and in 11 namespaces
▲ StopService method
Returnuint32 {'out':True}
StopService method is in 23 classes of ROOT\virtualization\v2 and in 11 namespaces

Detailed description of Msvm_GuestFileService properties

Derived properties (28) of Msvm_GuestFileService class

▲ AvailableRequestedStates property
CIMTYPE'uint16'
AvailableRequestedStates property is in 106 classes of ROOT\virtualization\v2 and in 7 namespaces
▲ Caption property
CIMTYPE'string'
Caption property is in 222 classes of ROOT\virtualization\v2 and in 37 namespaces
▲ CommunicationStatus property
CIMTYPE'uint16'
CommunicationStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
▲ CreationClassName property
CIMTYPE'string'
keyTrue
CreationClassName property is in 113 classes of ROOT\virtualization\v2 and in 20 namespaces
▲ Description property
CIMTYPE'string'
Description property is in 225 classes of ROOT\virtualization\v2 and in 142 namespaces
▲ DetailedStatus property
CIMTYPE'uint16'
DetailedStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
▲ ElementName property
CIMTYPE'string'
ElementName property is in 223 classes of ROOT\virtualization\v2 and in 21 namespaces
▲ EnabledDefault property
CIMTYPE'uint16'
EnabledDefault property is in 106 classes of ROOT\virtualization\v2 and in 10 namespaces
▲ EnabledState property
CIMTYPE'uint16'
EnabledState property is in 116 classes of ROOT\virtualization\v2 and in 13 namespaces
▲ HealthState property
CIMTYPE'uint16'
HealthState property is in 128 classes of ROOT\virtualization\v2 and in 15 namespaces
▲ InstallDate property
CIMTYPE'datetime'
InstallDate property is in 127 classes of ROOT\virtualization\v2 and in 23 namespaces
▲ InstanceID property
CIMTYPE'string'
InstanceID property is in 223 classes of ROOT\virtualization\v2 and in 21 namespaces
▲ Name property
CIMTYPE'string'
keyTrue
Name property is in 152 classes of ROOT\virtualization\v2 and in 142 namespaces
▲ OperatingStatus property
CIMTYPE'uint16'
OperatingStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
▲ OperationalStatus property
CIMTYPE'uint16'
OperationalStatus property is in 128 classes of ROOT\virtualization\v2 and in 18 namespaces
▲ OtherEnabledState property
CIMTYPE'string'
OtherEnabledState property is in 107 classes of ROOT\virtualization\v2 and in 11 namespaces
▲ PrimaryOwnerContact property
CIMTYPE'string'
PrimaryOwnerContact property is in 30 classes of ROOT\virtualization\v2 and in 15 namespaces
▲ PrimaryOwnerName property
CIMTYPE'string'
PrimaryOwnerName property is in 30 classes of ROOT\virtualization\v2 and in 15 namespaces
▲ PrimaryStatus property
CIMTYPE'uint16'
PrimaryStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
▲ RequestedState property
CIMTYPE'uint16'
RequestedState property is in 106 classes of ROOT\virtualization\v2 and in 12 namespaces
▲ Started property
CIMTYPE'boolean'
Started property is in 23 classes of ROOT\virtualization\v2 and in 11 namespaces
▲ StartMode property
CIMTYPE'string'
StartMode property is in 23 classes of ROOT\virtualization\v2 and in 15 namespaces
▲ Status property
CIMTYPE'string'
Status property is in 127 classes of ROOT\virtualization\v2 and in 42 namespaces
▲ StatusDescriptions property
CIMTYPE'string'
StatusDescriptions property is in 128 classes of ROOT\virtualization\v2 and in 18 namespaces
▲ SystemCreationClassName property
CIMTYPE'string'
keyTrue
SystemCreationClassName property is in 109 classes of ROOT\virtualization\v2 and in 20 namespaces
▲ SystemName property
CIMTYPE'string'
keyTrue
SystemName property is in 109 classes of ROOT\virtualization\v2 and in 22 namespaces
▲ TimeOfLastStateChange property
CIMTYPE'datetime'
TimeOfLastStateChange property is in 111 classes of ROOT\virtualization\v2 and in 17 namespaces
▲ TransitioningToState property
CIMTYPE'uint16'
TransitioningToState property is in 106 classes of ROOT\virtualization\v2 and in 7 namespaces

Msvm_GuestFileService Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
Description'Represents the guest file service. It is used for interacting with files in a guest, from the Hyper-V host.'✗✗✓✓✓
dynamicTrue✓✗✓✗✓
Locale1033✗✗✓✓✓
provider'VmmsWmiInstanceAndMethodProvider'✗✗✓✗✓

Msvm_GuestFileService System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\virtualization\v2:Msvm_GuestFileService'___SYSTEM8✗✗
__NAMESPACE'ROOT\virtualization\v2'___SYSTEM8✗✗
__SERVER'.'___SYSTEM8✗✗
__DERIVATION['Msvm_GuestService', 'CIM_Service', 'CIM_EnabledLogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement', 'CIM_ManagedElement']___SYSTEM8✗✓
__PROPERTY_COUNT28___SYSTEM3✗✗
__RELPATH'Msvm_GuestFileService'___SYSTEM8✗✗
__DYNASTY'CIM_ManagedElement'___SYSTEM8✗✗
__SUPERCLASS'Msvm_GuestService'___SYSTEM8✗✗
__CLASS'Msvm_GuestFileService'___SYSTEM8✗✗
__GENUS1___SYSTEM3✗✗
comments powered by Disqus
WUtils.com