# virt.instance.restart

Restart an instance.

Timeout is how long it should wait for the instance to shutdown cleanly.

This method is a job.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: id

#### id

Type: string

ID of the virtual instance to stop.

##### Parameter 2: stop_args

#### stop_args

Type: object Default: {"timeout": -1, "force": false}

Arguments controlling how the instance is stopped.

No Additional Properties

##

#### Timeout

Type: integer Default: -1

Timeout in seconds to wait for graceful shutdown (-1 for no timeout when `force = true`).

##

#### Force

Type: boolean Default: false

Whether to force stop the instance immediately without graceful shutdown.

##

#### Result

Type: boolean

Returns `true` if the instance was successfully restarted.

Required roles: VIRT_INSTANCE_WRITE