[PR #7263/28b3da88 backport][stable-7] [proxmox] return vmid and taskid #7307
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![patchback[bot]](https://avatars.githubusercontent.com/in/21488?s=60&v=4){kind=small}
* add vmid exit value
if create succeeds, we want the vmid
* fix syntax
* add vmid to return codes
* Add taskid to return, and only return vmid when it makes sense to
* add changelog fragment with temporary filename
* Add pr number to fragment
* fix PEP8 E501: line too long
* oops, I knew I still missed something...
* Update 7263-proxmox-return-vmid-and-taskid.yaml
Co-authored-by: Felix Fontein <felix@fontein.de>
* removed taskid from places it's not defined
* finally fixed sanity test errors
Okay, so maybe just waiting for CI to run the tests was a terrible idea.
I installed `inotifywait`, set up a venv for the tests, and in my
editor's terminal pane I ran the following, letting it run every save
until it exited:
until ansible-test sanity proxmox ; do
inotifywait --event modify plugins/modules/proxmox.py
done
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 28b3da8)
ansibullbot
added
backport
feature
felixfontein
deleted the
patchback/backports/stable-7/28b3da88a9b05743811452f2fcb6271249dac8f7/pr-7263
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a backport of PR #7263 as merged into main (28b3da8).
SUMMARY
Proxmox uses an internal ID number (
vmid) to refer to specific containers and virtual machines.Ansible's community.general.proxmox module allows an LXC container to be created with an automatically-assigned
vmid. However, presently (before this PR) it doesn't return the chosen ID. This means that the only way to programmatically delete a container that was programmatically created with an automatically-assigned ID involves string matching, string manipulation, and guesswork. (Some of the above logic already exists within the proxmox module, but I definitely don't trust the idea of deleting a VM based on an identifier that isn't even guaranteed unique!)Additionally, long-lived tasks such as creating/starting/updating/deleting VMs and containers are given
taskidnumbers that show up in the audit log and can be used to reference the status of the task. The community.general.proxmox does use thetaskidto keep track of dispatched tasks, but the module doesn't return it.This PR adds
vmidandtaskidto the data returned by such actions, at least where it would make sense to do so. This way, for example, I can make a bunch of containers with automatically-assigned IDs and use Ansible'sregisterfunction to reference them later in the play.Being able to save the
taskidmay also help with other execution strategies, or for matching Ansible logs with Proxmox audit logs, or something. I'm not sure, really, but it seemed like a good idea to add it in while I was already there.ISSUE TYPE
COMPONENT NAME
proxmox
ADDITIONAL INFORMATION
This is my first contribution to Ansible, and probably my first time contributing Python code to any FOSS project! Please be gentle and be understanding if I missed anything.