VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::vcenter::Folder Interface Reference

The Folder interface provides methods for manipulating a vCenter Server folder. More...

Inherited by vmware::vcenter::FolderStub.

List of all members.

Public Member Functions

global::System.Collections.Generic.List
< vmware.vcenter.FolderTypes.Summary
List (vmware.vcenter.FolderTypes.FilterSpec filter)
 Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Folder.FilterSpec .
global::System.Collections.Generic.List
< vmware.vcenter.FolderTypes.Summary
List (vmware.vcenter.FolderTypes.FilterSpec filter, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Folder.FilterSpec .
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.vcenter.FolderTypes.Summary > > 
ListAsync (vmware.vcenter.FolderTypes.FilterSpec filter)
 Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Folder.FilterSpec .
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.vcenter.FolderTypes.Summary > > 
ListAsync (vmware.vcenter.FolderTypes.FilterSpec filter, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Folder.FilterSpec .

Detailed Description

The Folder interface provides methods for manipulating a vCenter Server folder.


Member Function Documentation

global::System.Collections.Generic.List<vmware.vcenter.FolderTypes.Summary> vmware::vcenter::Folder::List ( vmware.vcenter.FolderTypes.FilterSpec  filter)

Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Folder.FilterSpec .

Exceptions:
vmware.vapi.std.errors.InvalidArgumentif the Folder.FilterSpec.type field contains a value that is not supported by the server.
vmware.vapi.std.errors.UnableToAllocateResourceif more than 1000 folders match the Folder.FilterSpec
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
Parameters:
filterSpecification of matching folders for which information should be returned. If null, the behavior is equivalent to a Folder.FilterSpec with all fields null which means all folders match the filter.
Returns:
Commonly used information about the folders matching the Folder.FilterSpec .

Implemented in vmware::vcenter::FolderStub.

global::System.Collections.Generic.List<vmware.vcenter.FolderTypes.Summary> vmware::vcenter::Folder::List ( vmware.vcenter.FolderTypes.FilterSpec  filter,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Folder.FilterSpec .

Exceptions:
vmware.vapi.std.errors.InvalidArgumentif the Folder.FilterSpec.type field contains a value that is not supported by the server.
vmware.vapi.std.errors.UnableToAllocateResourceif more than 1000 folders match the Folder.FilterSpec
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
Parameters:
filterSpecification of matching folders for which information should be returned. If null, the behavior is equivalent to a Folder.FilterSpec with all fields null which means all folders match the filter.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Commonly used information about the folders matching the Folder.FilterSpec .

Implemented in vmware::vcenter::FolderStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.FolderTypes.Summary> > vmware::vcenter::Folder::ListAsync ( vmware.vcenter.FolderTypes.FilterSpec  filter)

Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Folder.FilterSpec .

Exceptions:
vmware.vapi.std.errors.InvalidArgumentif the Folder.FilterSpec.type field contains a value that is not supported by the server.
vmware.vapi.std.errors.UnableToAllocateResourceif more than 1000 folders match the Folder.FilterSpec
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
Parameters:
filterSpecification of matching folders for which information should be returned. If null, the behavior is equivalent to a Folder.FilterSpec with all fields null which means all folders match the filter.
Returns:
Commonly used information about the folders matching the Folder.FilterSpec .

Implemented in vmware::vcenter::FolderStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.FolderTypes.Summary> > vmware::vcenter::Folder::ListAsync ( vmware.vcenter.FolderTypes.FilterSpec  filter,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Folder.FilterSpec .

Exceptions:
vmware.vapi.std.errors.InvalidArgumentif the Folder.FilterSpec.type field contains a value that is not supported by the server.
vmware.vapi.std.errors.UnableToAllocateResourceif more than 1000 folders match the Folder.FilterSpec
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
Parameters:
filterSpecification of matching folders for which information should be returned. If null, the behavior is equivalent to a Folder.FilterSpec with all fields null which means all folders match the filter.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Commonly used information about the folders matching the Folder.FilterSpec .

Implemented in vmware::vcenter::FolderStub.


The documentation for this interface was generated from the following file: