@aleph-sdk/monorepo
Preparing search index...
client/src
VmClient
Class VmClient
Index
Accessors
node
Domain
Methods
build
Headers
create
Backup
delete
Backup
ensure
Pubkey
Header
erase
Instance
expire
Instance
get
Backup
get
Restore
Endpoint
get
Stream
Logs
Url
perform
Operation
reboot
Instance
reinstall
Instance
reserve
Resources
restore
From
File
restore
From
Volume
start
Instance
stop
Instance
stream
Logs
create
Accessors
node
Domain
get
nodeDomain
()
:
string
Returns
string
Methods
build
Headers
buildHeaders
(
vmId
:
string
,
operation
:
VmOperation
,
method
?:
string
,
)
:
Promise
<
{
headers
:
Record
<
string
,
string
>
;
url
:
string
}
>
Parameters
vmId
:
string
operation
:
VmOperation
method
:
string
= 'POST'
Returns
Promise
<
{
headers
:
Record
<
string
,
string
>
;
url
:
string
}
>
create
Backup
createBackup
(
vmId
:
string
,
options
?:
{
includeVolumes
?:
boolean
;
skipFsfreeze
?:
boolean
}
,
)
:
Promise
<
VmOperationResult
>
Parameters
vmId
:
string
Optional
options
:
{
includeVolumes
?:
boolean
;
skipFsfreeze
?:
boolean
}
Returns
Promise
<
VmOperationResult
>
delete
Backup
deleteBackup
(
vmId
:
string
,
backupId
:
string
)
:
Promise
<
VmOperationResult
>
Parameters
vmId
:
string
backupId
:
string
Returns
Promise
<
VmOperationResult
>
ensure
Pubkey
Header
ensurePubkeyHeader
()
:
Promise
<
string
>
Returns
Promise
<
string
>
erase
Instance
eraseInstance
(
vmId
:
string
)
:
Promise
<
VmOperationResult
>
Parameters
vmId
:
string
Returns
Promise
<
VmOperationResult
>
expire
Instance
expireInstance
(
vmId
:
string
)
:
Promise
<
VmOperationResult
>
Parameters
vmId
:
string
Returns
Promise
<
VmOperationResult
>
get
Backup
getBackup
(
vmId
:
string
)
:
Promise
<
VmOperationResult
>
Parameters
vmId
:
string
Returns
Promise
<
VmOperationResult
>
get
Restore
Endpoint
getRestoreEndpoint
(
vmId
:
string
,
)
:
Promise
<
{
headers
:
Record
<
string
,
string
>
;
url
:
string
}
>
Parameters
vmId
:
string
Returns
Promise
<
{
headers
:
Record
<
string
,
string
>
;
url
:
string
}
>
get
Stream
Logs
Url
getStreamLogsUrl
(
vmId
:
string
)
:
string
Parameters
vmId
:
string
Returns
string
perform
Operation
performOperation
(
vmId
:
string
,
operation
:
VmOperation
,
options
?:
{
jsonData
?:
unknown
;
method
?:
string
;
params
?:
Record
<
string
,
string
>
;
}
,
)
:
Promise
<
VmOperationResult
>
Parameters
vmId
:
string
operation
:
VmOperation
Optional
options
:
{
jsonData
?:
unknown
;
method
?:
string
;
params
?:
Record
<
string
,
string
>
}
Returns
Promise
<
VmOperationResult
>
reboot
Instance
rebootInstance
(
vmId
:
string
)
:
Promise
<
VmOperationResult
>
Parameters
vmId
:
string
Returns
Promise
<
VmOperationResult
>
reinstall
Instance
reinstallInstance
(
vmId
:
string
,
eraseVolumes
?:
boolean
,
)
:
Promise
<
VmOperationResult
>
Parameters
vmId
:
string
Optional
eraseVolumes
:
boolean
Returns
Promise
<
VmOperationResult
>
reserve
Resources
reserveResources
(
config
:
Record
<
string
,
unknown
>
)
:
Promise
<
VmOperationResult
>
Parameters
config
:
Record
<
string
,
unknown
>
Returns
Promise
<
VmOperationResult
>
restore
From
File
restoreFromFile
(
vmId
:
string
,
rootfsData
:
Blob
)
:
Promise
<
VmOperationResult
>
Parameters
vmId
:
string
rootfsData
:
Blob
Returns
Promise
<
VmOperationResult
>
restore
From
Volume
restoreFromVolume
(
vmId
:
string
,
volumeRef
:
string
)
:
Promise
<
VmOperationResult
>
Parameters
vmId
:
string
volumeRef
:
string
Returns
Promise
<
VmOperationResult
>
start
Instance
startInstance
(
vmId
:
string
)
:
Promise
<
VmOperationResult
>
Parameters
vmId
:
string
Returns
Promise
<
VmOperationResult
>
stop
Instance
stopInstance
(
vmId
:
string
)
:
Promise
<
VmOperationResult
>
Parameters
vmId
:
string
Returns
Promise
<
VmOperationResult
>
stream
Logs
streamLogs
(
vmId
:
string
,
abort
?:
AbortSignal
)
:
AsyncGenerator
<
LogEntry
>
Parameters
vmId
:
string
Optional
abort
:
AbortSignal
Returns
AsyncGenerator
<
LogEntry
>
Static
create
create
(
account
:
Account
,
nodeUrl
:
string
)
:
Promise
<
VmClient
>
Parameters
account
:
Account
nodeUrl
:
string
Returns
Promise
<
VmClient
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Accessors
node
Domain
Methods
build
Headers
create
Backup
delete
Backup
ensure
Pubkey
Header
erase
Instance
expire
Instance
get
Backup
get
Restore
Endpoint
get
Stream
Logs
Url
perform
Operation
reboot
Instance
reinstall
Instance
reserve
Resources
restore
From
File
restore
From
Volume
start
Instance
stop
Instance
stream
Logs
create
@aleph-sdk/monorepo
Loading...