qiyutech.proxmox.hl_qemu_op module – QEMU 虚拟机 操作

备注

This module is part of the qiyutech.proxmox collection (version 1.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install qiyutech.proxmox.

To use it in a playbook, specify: qiyutech.proxmox.hl_qemu_op.

1.0.0 新版功能: of qiyutech.proxmox

Synopsis

  • 启动、暂停 QEMU 虚拟机

备注

This module has a corresponding action plugin.

Parameters

Parameter

Comments

host

string / required

Proxmox API server

这个参数是必须的

参数获取顺序:

1 host 任务参数

2 proxmox_host 变量 (aka: task_vars 中的 proxmox_host 变量)

3 PROXMOX_HOST 任务环境变量

4 PROXMOX_HOST 全局环境变量

node

string / required

PVE集群节点名称

snapname

string

运行哪个虚拟机

state 为 stopped 时:

  • 此值无需使用

state 为 running 时:

  • 如果是 current 则检查默认是否运行

  • 其他则先回滚到 snapname 然后启动运行state 为 snapshot 时:

  • 使用 current 创建名称为 snapname 的快照

Default: “current”

state

string

QEMU虚拟机状态

Choices:

  • stopped

  • running ← (default)

timeout

integer

等待超时时间

state = stopped 的时候有效

Default: 0

token_id

string / required

Proxmox API Token ID

这个参数是必须的

参数获取顺序:

1 token_id 任务参数

2 proxmox_token_id 变量 (aka: task_vars 中的 proxmox_token_id 变量)

3 PROXMOX_TOKEN_ID 任务环境变量

4 PROXMOX_TOKEN_ID 全局环境变量

token_secret

string / required

Proxmox API Token Secret

这个参数是必须的

参数获取顺序:

1 token_secret 任务参数

2 proxmox_token_secret 变量 (aka: task_vars 中的 proxmox_token_secret 变量)

3 PROXMOX_TOKEN_SECRET 任务环境变量

4 PROXMOX_TOKEN_SECRET 全局环境变量

vmid

integer / required

虚拟机ID

Examples

- name: 启动虚拟机
  qiyutech.proxmox.hl_qemu_op:
    node: 'qiyutech'
    vmid: 102
    state: 'running'

- name: 使用 demo 快照启动虚拟机
  qiyutech.proxmox.hl_qemu_op:
    node: 'qiyutech'
    vmid: 102
    state: 'running'
    snapname: demo

- name: 停止虚拟机
  qiyutech.proxmox.hl_qemu_op:
    node: 'qiyutech'
    vmid: 102
    state: 'stopped'

Authors

  • dev