vmware::appliance::recovery::backup::Schedules Interface Reference

The Schedules interface provides methods to be performed to manage backup schedules. More...

Inherited by vmware::appliance::recovery::backup::SchedulesStub.

List of all members.

Public Member Functions
global::System.Collections.Generic.Dictionary < string, vmware.appliance.recovery.backup.SchedulesTypes.Info >	List ()
	Returns a list of existing schedules with details.
global::System.Collections.Generic.Dictionary < string, vmware.appliance.recovery.backup.SchedulesTypes.Info >	List (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns a list of existing schedules with details.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.Dictionary < string, vmware.appliance.recovery.backup.SchedulesTypes.Info > >	ListAsync ()
	Returns a list of existing schedules with details.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.Dictionary < string, vmware.appliance.recovery.backup.SchedulesTypes.Info > >	ListAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns a list of existing schedules with details.
vmware.appliance.recovery.backup.JobTypes.BackupJobStatus	Run (string schedule, string comment)
	Initiate backup with the specified schedule.
vmware.appliance.recovery.backup.JobTypes.BackupJobStatus	Run (string schedule, string comment, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Initiate backup with the specified schedule.
global::System.Threading.Tasks.Task < vmware.appliance.recovery.backup.JobTypes.BackupJobStatus >	RunAsync (string schedule, string comment)
	Initiate backup with the specified schedule.
global::System.Threading.Tasks.Task < vmware.appliance.recovery.backup.JobTypes.BackupJobStatus >	RunAsync (string schedule, string comment, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Initiate backup with the specified schedule.
vmware.appliance.recovery.backup.SchedulesTypes.Info	Get (string schedule)
	Returns an existing schedule information based on id.
vmware.appliance.recovery.backup.SchedulesTypes.Info	Get (string schedule, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns an existing schedule information based on id.
global::System.Threading.Tasks.Task < vmware.appliance.recovery.backup.SchedulesTypes.Info >	GetAsync (string schedule)
	Returns an existing schedule information based on id.
global::System.Threading.Tasks.Task < vmware.appliance.recovery.backup.SchedulesTypes.Info >	GetAsync (string schedule, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns an existing schedule information based on id.
void	Create (string schedule, vmware.appliance.recovery.backup.SchedulesTypes.CreateSpec spec)
	Creates a schedule.
void	Create (string schedule, vmware.appliance.recovery.backup.SchedulesTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Creates a schedule.
global::System.Threading.Tasks.Task	CreateAsync (string schedule, vmware.appliance.recovery.backup.SchedulesTypes.CreateSpec spec)
	Creates a schedule.
global::System.Threading.Tasks.Task	CreateAsync (string schedule, vmware.appliance.recovery.backup.SchedulesTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Creates a schedule.
void	Update (string schedule, vmware.appliance.recovery.backup.SchedulesTypes.UpdateSpec spec)
	Updates a schedule.
void	Update (string schedule, vmware.appliance.recovery.backup.SchedulesTypes.UpdateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Updates a schedule.
global::System.Threading.Tasks.Task	UpdateAsync (string schedule, vmware.appliance.recovery.backup.SchedulesTypes.UpdateSpec spec)
	Updates a schedule.
global::System.Threading.Tasks.Task	UpdateAsync (string schedule, vmware.appliance.recovery.backup.SchedulesTypes.UpdateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Updates a schedule.
void	Delete (string schedule)
	Deletes an existing schedule.
void	Delete (string schedule, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Deletes an existing schedule.
global::System.Threading.Tasks.Task	DeleteAsync (string schedule)
	Deletes an existing schedule.
global::System.Threading.Tasks.Task	DeleteAsync (string schedule, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Deletes an existing schedule.

---

Detailed Description

The Schedules interface provides methods to be performed to manage backup schedules.

This interface was added in vSphere API 6.7.

---

Member Function Documentation

void vmware::appliance::recovery::backup::Schedules::Create	(	string	schedule,
		vmware.appliance.recovery.backup.SchedulesTypes.CreateSpec	spec
	)

Creates a schedule.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if provided with invalid schedule specification.
vmware.vapi.std.errors.AlreadyExists	if the schedule with the given id already exists.
vmware.vapi.std.errors.Error	if any error occurs during the execution of the operation.

Parameters:

schedule	Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .
spec	CreateSpec Structure

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

void vmware::appliance::recovery::backup::Schedules::Create	(	string	schedule,
		vmware.appliance.recovery.backup.SchedulesTypes.CreateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Creates a schedule.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if provided with invalid schedule specification.
vmware.vapi.std.errors.AlreadyExists	if the schedule with the given id already exists.
vmware.vapi.std.errors.Error	if any error occurs during the execution of the operation.

Parameters:

schedule	Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .
spec	CreateSpec Structure
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

global::System.Threading.Tasks.Task vmware::appliance::recovery::backup::Schedules::CreateAsync	(	string	schedule,
		vmware.appliance.recovery.backup.SchedulesTypes.CreateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Creates a schedule.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if provided with invalid schedule specification.
vmware.vapi.std.errors.AlreadyExists	if the schedule with the given id already exists.
vmware.vapi.std.errors.Error	if any error occurs during the execution of the operation.

Parameters:

schedule	Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .
spec	CreateSpec Structure
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

global::System.Threading.Tasks.Task vmware::appliance::recovery::backup::Schedules::CreateAsync	(	string	schedule,
		vmware.appliance.recovery.backup.SchedulesTypes.CreateSpec	spec
	)

Creates a schedule.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if provided with invalid schedule specification.
vmware.vapi.std.errors.AlreadyExists	if the schedule with the given id already exists.
vmware.vapi.std.errors.Error	if any error occurs during the execution of the operation.

Parameters:

schedule	Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .
spec	CreateSpec Structure

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

void vmware::appliance::recovery::backup::Schedules::Delete

(

string

schedule

)

Deletes an existing schedule.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if schedule associated with id does not exist.
vmware.vapi.std.errors.Error	if any error occurs during the execution of the operation.

Parameters:

schedule

Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

void vmware::appliance::recovery::backup::Schedules::Delete	(	string	schedule,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Deletes an existing schedule.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if schedule associated with id does not exist.
vmware.vapi.std.errors.Error	if any error occurs during the execution of the operation.

Parameters:

schedule	Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

global::System.Threading.Tasks.Task vmware::appliance::recovery::backup::Schedules::DeleteAsync

(

string

schedule

)

Deletes an existing schedule.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if schedule associated with id does not exist.
vmware.vapi.std.errors.Error	if any error occurs during the execution of the operation.

Parameters:

schedule

Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

global::System.Threading.Tasks.Task vmware::appliance::recovery::backup::Schedules::DeleteAsync	(	string	schedule,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Deletes an existing schedule.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if schedule associated with id does not exist.
vmware.vapi.std.errors.Error	if any error occurs during the execution of the operation.

Parameters:

schedule	Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

vmware.appliance.recovery.backup.SchedulesTypes.Info vmware::appliance::recovery::backup::Schedules::Get	(	string	schedule,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns an existing schedule information based on id.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if schedule associated with id does not exist.
vmware.vapi.std.errors.Error	if any error occurs during the execution of the operation.

Parameters:

schedule	Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Info Structure

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

vmware.appliance.recovery.backup.SchedulesTypes.Info vmware::appliance::recovery::backup::Schedules::Get

(

string

schedule

)

Returns an existing schedule information based on id.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if schedule associated with id does not exist.
vmware.vapi.std.errors.Error	if any error occurs during the execution of the operation.

Parameters:

schedule

Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .

Returns:

Info Structure

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

global::System.Threading.Tasks.Task<vmware.appliance.recovery.backup.SchedulesTypes.Info> vmware::appliance::recovery::backup::Schedules::GetAsync

(

string

schedule

)

Returns an existing schedule information based on id.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if schedule associated with id does not exist.
vmware.vapi.std.errors.Error	if any error occurs during the execution of the operation.

Parameters:

schedule

Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .

Returns:

Info Structure

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

global::System.Threading.Tasks.Task<vmware.appliance.recovery.backup.SchedulesTypes.Info> vmware::appliance::recovery::backup::Schedules::GetAsync	(	string	schedule,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns an existing schedule information based on id.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if schedule associated with id does not exist.
vmware.vapi.std.errors.Error	if any error occurs during the execution of the operation.

Parameters:

schedule	Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Info Structure

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

global::System.Collections.Generic.Dictionary<string, vmware.appliance.recovery.backup.SchedulesTypes.Info> vmware::appliance::recovery::backup::Schedules::List	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns a list of existing schedules with details.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

if any error occurs during the execution of the operation.

Returns:

Map of schedule id to Info Structure The key in the result map will be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

global::System.Collections.Generic.Dictionary<string, vmware.appliance.recovery.backup.SchedulesTypes.Info> vmware::appliance::recovery::backup::Schedules::List

(

)

Returns a list of existing schedules with details.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

if any error occurs during the execution of the operation.

Returns:

Map of schedule id to Info Structure The key in the result map will be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.Dictionary<string, vmware.appliance.recovery.backup.SchedulesTypes.Info> > vmware::appliance::recovery::backup::Schedules::ListAsync	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns a list of existing schedules with details.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

if any error occurs during the execution of the operation.

Returns:

Map of schedule id to Info Structure The key in the result map will be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.Dictionary<string, vmware.appliance.recovery.backup.SchedulesTypes.Info> > vmware::appliance::recovery::backup::Schedules::ListAsync

(

)

Returns a list of existing schedules with details.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

if any error occurs during the execution of the operation.

Returns:

Map of schedule id to Info Structure The key in the result map will be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

vmware.appliance.recovery.backup.JobTypes.BackupJobStatus vmware::appliance::recovery::backup::Schedules::Run	(	string	schedule,
		string	comment
	)

Initiate backup with the specified schedule.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.FeatureInUse	if a backup or restore is already in progress.
vmware.vapi.std.errors.NotFound	if schedule associated with id does not exist.
vmware.vapi.std.errors.Error	if any error occurs during the execution of the operation.

Parameters:

schedule	Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .
comment	field that specifies the description for the backup. If null the backup will have an empty comment.

Returns:

BackupJobStatus Structure

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

vmware.appliance.recovery.backup.JobTypes.BackupJobStatus vmware::appliance::recovery::backup::Schedules::Run	(	string	schedule,
		string	comment,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Initiate backup with the specified schedule.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.FeatureInUse	if a backup or restore is already in progress.
vmware.vapi.std.errors.NotFound	if schedule associated with id does not exist.
vmware.vapi.std.errors.Error	if any error occurs during the execution of the operation.

Parameters:

schedule	Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .
comment	field that specifies the description for the backup. If null the backup will have an empty comment.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

BackupJobStatus Structure

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

global::System.Threading.Tasks.Task<vmware.appliance.recovery.backup.JobTypes.BackupJobStatus> vmware::appliance::recovery::backup::Schedules::RunAsync	(	string	schedule,
		string	comment
	)

Initiate backup with the specified schedule.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.FeatureInUse	if a backup or restore is already in progress.
vmware.vapi.std.errors.NotFound	if schedule associated with id does not exist.
vmware.vapi.std.errors.Error	if any error occurs during the execution of the operation.

Parameters:

schedule	Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .
comment	field that specifies the description for the backup. If null the backup will have an empty comment.

Returns:

BackupJobStatus Structure

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

global::System.Threading.Tasks.Task<vmware.appliance.recovery.backup.JobTypes.BackupJobStatus> vmware::appliance::recovery::backup::Schedules::RunAsync	(	string	schedule,
		string	comment,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Initiate backup with the specified schedule.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.FeatureInUse	if a backup or restore is already in progress.
vmware.vapi.std.errors.NotFound	if schedule associated with id does not exist.
vmware.vapi.std.errors.Error	if any error occurs during the execution of the operation.

Parameters:

schedule	Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .
comment	field that specifies the description for the backup. If null the backup will have an empty comment.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

BackupJobStatus Structure

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

void vmware::appliance::recovery::backup::Schedules::Update	(	string	schedule,
		vmware.appliance.recovery.backup.SchedulesTypes.UpdateSpec	spec
	)

Updates a schedule.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if provided with invalid schedule specification.
vmware.vapi.std.errors.NotFound	if schedule associated with id does not exist.
vmware.vapi.std.errors.Error	if any error occurs during the execution of the operation.

Parameters:

schedule	Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .
spec	UpdateSpec Structure

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

void vmware::appliance::recovery::backup::Schedules::Update	(	string	schedule,
		vmware.appliance.recovery.backup.SchedulesTypes.UpdateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Updates a schedule.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if provided with invalid schedule specification.
vmware.vapi.std.errors.NotFound	if schedule associated with id does not exist.
vmware.vapi.std.errors.Error	if any error occurs during the execution of the operation.

Parameters:

schedule	Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .
spec	UpdateSpec Structure
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

global::System.Threading.Tasks.Task vmware::appliance::recovery::backup::Schedules::UpdateAsync	(	string	schedule,
		vmware.appliance.recovery.backup.SchedulesTypes.UpdateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Updates a schedule.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if provided with invalid schedule specification.
vmware.vapi.std.errors.NotFound	if schedule associated with id does not exist.
vmware.vapi.std.errors.Error	if any error occurs during the execution of the operation.

Parameters:

schedule	Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .
spec	UpdateSpec Structure
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

global::System.Threading.Tasks.Task vmware::appliance::recovery::backup::Schedules::UpdateAsync	(	string	schedule,
		vmware.appliance.recovery.backup.SchedulesTypes.UpdateSpec	spec
	)

Updates a schedule.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if provided with invalid schedule specification.
vmware.vapi.std.errors.NotFound	if schedule associated with id does not exist.
vmware.vapi.std.errors.Error	if any error occurs during the execution of the operation.

Parameters:

schedule	Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule .
spec	UpdateSpec Structure

Implemented in vmware::appliance::recovery::backup::SchedulesStub.

---

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

• Schedules.cs